Struct lychee_lib::Uri

pub struct Uri { /* private fields */ }

Lychee’s own representation of a URI, which encapsulates all supported formats.

If the scheme is mailto, it’s a mail address. Otherwise it’s treated as a website URL.

Implementations

impl Uri

pub fn as_str(&self) -> &str

Returns the string representation of the Uri.

If it’s an email address, returns the string with scheme stripped. Otherwise returns the string as-is.

pub fn scheme(&self) -> &str

Returns the scheme of the URI (e.g. http or mailto)

pub fn domain(&self) -> Option<&str>

Returns the domain of the URI (e.g. example.com)

pub fn path(&self) -> &str

Returns the path of the URI (e.g. /path/to/resource)

pub fn path_segments(&self) -> Option<Split<'_, char>>

Unless this URL is cannot-be-a-base, return an iterator of ‘/’ slash-separated path segments, each as a percent-encoded ASCII string.

Return None for cannot-be-a-base URLs.

pub fn host_ip(&self) -> Option<IpAddr>

Returns the IP address (either IPv4 or IPv6) of the URI, or None if it is a domain

pub fn is_mail(&self) -> bool

Check if the URI is a valid mail address

pub fn is_file(&self) -> bool

Check if the URI is a file

pub fn is_data(&self) -> bool

Check if the URI is a data URI

pub fn is_loopback(&self) -> bool

Returns true if this is a loopback address.

IPv4

This is a loopback address (127.0.0.0/8).

This property is defined by IETF RFC 1122.

IPv6

This is the loopback address (::1), as defined in IETF RFC 4291 section 2.5.3.

pub fn is_private(&self) -> bool

Returns true if this is a private IPv4 address, a unique local IPv6 address (fc00::/7).

IPv4

The private address ranges are defined in IETF RFC 1918 and include:

• 10.0.0.0/8
• 172.16.0.0/12
• 192.168.0.0/16

IPv6

Unique local address is defined in IETF RFC 4193.

Note

Unicast site-local network was defined in IETF RFC 4291, but was fully deprecated in IETF RFC 3879. So it is NOT considered as private on this purpose.

pub fn is_link_local(&self) -> bool

Returns true if the address is a link-local IPv4 address (169.254.0.0/16), or an IPv6 unicast address with link-local scope (fe80::/10).

IPv4

Link-local address is defined by IETF RFC 3927.

IPv6

Unicast address with link-local scope is defined in IETF RFC 4291.

Trait Implementations

impl AsRef<str> for Uri

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Uri

fn clone(&self) -> Uri

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Uri

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Uri

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Uri

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Url> for Uri

fn from(url: Url) -> Self

Converts to this type from the input type.

impl Hash for Uri

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Uri

fn cmp(&self, other: &Uri) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Uri

fn eq(&self, other: &Uri) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Uri

fn partial_cmp(&self, other: &Uri) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Uri

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Uri

fn try_from(s: &str) -> Result<Self>

Create a new URI from a string

Note: We do not handle relative URLs here, as we do not know the base URL. Furthermore paths also cannot be resolved, as we do not know the file system.

Errors

Returns an error if the string is not a valid URI

type Error = ErrorKind

The type returned in the event of a conversion error.

impl TryFrom<String> for Uri

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self>

Performs the conversion.

impl TryFrom<Uri> for Request

type Error = ErrorKind

The type returned in the event of a conversion error.

fn try_from(uri: Uri) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Uri

impl StructuralPartialEq for Uri