gossamer - v9.2.0

gossamer/url

Types

URL

</>

A parsed URL. Mutable — setters like set_hostname modify the URL in place and return it for chaining.

See URL on MDN.

pub type URL

Values

can_parse

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

can_parse_with_base

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

create_object_url

</> 
pub fn create_object_url(blob: blob.Blob) -> String

Creates a string containing a URL representing the given blob. The URL lifetime is tied to the document or worker that created it.

hash

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

host

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

hostname

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

href

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

new

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

Parses url into a URL. Returns an error if the string is not a valid absolute URL.

new_with_base

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

Parses url, resolving relative URLs against base. Returns an error if the resolved URL is invalid.

origin

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

parse

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

Like new, but returns Error(Nil) rather than a JsError when the URL is invalid.

parse_with_base

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

Like new_with_base, but returns Error(Nil) rather than a JsError when the URL is invalid.

password

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

pathname

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

port

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

protocol

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

revoke_object_url

</> 
pub fn revoke_object_url(url: String) -> Nil

Revokes an object URL previously created with create_object_url. Call this to release the reference once the URL is no longer needed.

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

search_params

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

set_hash

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

set_host

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

set_hostname

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

set_href

</> 
pub fn set_href(
  of url: URL,
  to href: String,
) -> Result(URL, js_error.JsError)

Sets the full URL string, reparsing it. Returns an error if the new href is not a valid URL.

set_password

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

set_pathname

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

set_port

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

set_protocol

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

set_username

</> 
pub fn set_username(of url: URL, to 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(of url: URL) -> String
✨ Search Document