Struct mail::IRI

pub struct IRI { /* fields omitted */ }

A minimal IRI (International Resource Identifier) implementation which just parses the scheme but no scheme specific part (and neither fragments wrt. those definitions in which fragments are not scheme specific parts).

This implementation does not perform any form of normalization or other IRI specific aspects, it's basically just a String split into two parts.

Additionally this implementations requires all URI to be valid utf8.

Example

let uri = IRI::new("file:/random/logo.png").unwrap();
assert_eq!(uri.scheme(), "file");
assert_eq!(uri.tail(), "/random/logo.png");

Implementations

impl IRI

pub fn from_parts(scheme: &str, tail: &str) -> Result<IRI, InvalidIRIScheme>

Create a new IRI from a scheme part and a tail part.

This will convert the scheme part into lower case before using it.

pub fn new<I>(iri: I) -> Result<IRI, InvalidIRIScheme> where
    I: Into<String>, 

crates a new a IRI

1. this determines the first occurrence of : to split the input into scheme and tail
2. it validates that the scheme name is RFC 3986 compatible, i.e. is ascii, starting with a letter followed by alpha numeric characters (or "+","-",".").
3. converts the scheme part to lower case

pub fn with_tail(&self, new_tail: &str) -> IRI

Creates a new IRI with the same schema but a different tail.

pub fn scheme(&self) -> &str

The scheme part of the uri excluding the : seperator.

The scheme is guaranteed to be lower case.

Example

let uri = IRI::new("file:///opt/share/logo.png").unwrap();
assert_eq!(uri.scheme(), "file");

pub fn tail(&self) -> &str

the scheme specific part of the uri

Example

let uri = IRI::new("file:///opt/share/logo.png").unwrap();
assert_eq!(uri.scheme(), "file");

pub fn as_str(&self) -> &str

returns the underlying string representation

Note that it does not implement Display even through it implements as_str and Into<String> as displaying a IRI is more complex then just displaying a string (mainly due to bidirectional IRI's).

Trait Implementations

impl Clone for IRI

fn clone(&self) -> IRI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IRI

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IRI

fn deserialize<D>(
    deserializer: D
) -> Result<IRI, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for IRI

impl FromStr for IRI

type Err = InvalidIRIScheme

The associated error which can be returned from parsing.

fn from_str(inp: &str) -> Result<IRI, <IRI as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for IRI

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Into<String> for IRI

fn into(self) -> String

Performs the conversion.

impl Ord for IRI

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<IRI> for IRI

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

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

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

This method tests for !=.

impl PartialOrd<IRI> for IRI

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

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

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

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

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

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

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

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

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

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

impl PathRebaseable for IRI

fn rebase_to_include_base_dir(
    &mut self,
    base_dir: impl AsRef<Path>
) -> Result<(), UnsupportedPathError>

Prefixes path in the type with base_dir.

fn rebase_to_exclude_base_dir(
    &mut self,
    base_dir: impl AsRef<Path>
) -> Result<(), UnsupportedPathError>

Removes the base_dir prefix.

impl Serialize for IRI

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for IRI

impl StructuralPartialEq for IRI