gossamer - v2.0.0

gossamer/url

Types

URL

</>

The URL interface represents an object providing static methods used for creating, parsing, and manipulating URLs.

pub type URL

Values

can_parse

</> 
pub fn can_parse(url: String) -> Bool

Returns a boolean value indicating if a URL string is valid and can be parsed.

can_parse_with_base

</> 
pub fn can_parse_with_base(url: String, base: String) -> Bool

Returns a boolean value indicating if a URL string with a base is valid and can be parsed.

hash

</> 
pub fn hash(url: URL) -> String

host

</> 
pub fn host(url: URL) -> String

hostname

</> 
pub fn hostname(url: URL) -> String

href

</> 
pub fn href(url: URL) -> String

new

</> 
pub fn new(url: String) -> Result(URL, String)

Creates a new URL object by parsing the specified URL string. Returns an error if the URL is invalid.

new_with_base

</> 
pub fn new_with_base(
  url: String,
  base: String,
) -> Result(URL, String)

Creates a new URL object by parsing the specified URL string with a base URL. Returns an error if the URL is invalid.

origin

</> 
pub fn origin(url: URL) -> String

The origin of the URL.

parse

</> 
pub fn parse(url: String) -> Result(URL, Nil)

Parses a URL string and returns a URL object, or an error if invalid.

parse_with_base

</> 
pub fn parse_with_base(
  url: String,
  base: String,
) -> Result(URL, Nil)

Parses a URL string relative to a base URL and returns a URL object, or an error if invalid.

password

</> 
pub fn password(url: URL) -> String

pathname

</> 
pub fn pathname(url: URL) -> String

port

</> 
pub fn port(url: URL) -> String

protocol

</> 
pub fn protocol(url: URL) -> String
</> 
pub fn search(url: URL) -> String

search_params

</> 
pub fn search_params(
  url: URL,
) -> url_search_params.URLSearchParams

set_hash

</> 
pub fn set_hash(url: URL, hash: String) -> URL

set_host

</> 
pub fn set_host(url: URL, host: String) -> URL

set_hostname

</> 
pub fn set_hostname(url: URL, hostname: String) -> URL

set_href

</> 
pub fn set_href(url: URL, href: String) -> URL

set_password

</> 
pub fn set_password(url: URL, password: String) -> URL

set_pathname

</> 
pub fn set_pathname(url: URL, pathname: String) -> URL

set_port

</> 
pub fn set_port(url: URL, port: String) -> URL

set_protocol

</> 
pub fn set_protocol(url: URL, protocol: String) -> URL
</> 
pub fn set_search(url: URL, search: String) -> URL

set_username

</> 
pub fn set_username(url: URL, username: String) -> URL

to_json

</> 
pub fn to_json(url: URL) -> String

to_string

</> 
pub fn to_string(url: URL) -> String

username

</> 
pub fn username(url: URL) -> String
✨ Search Document