Struct iref::Iri

pub struct Iri<'a>(_);

IRI slice.

Wrapper around a borrowed bytes slice representing an IRI. An IRI can be seen as an IRI-reference with a defined Scheme. All methods of IriRef are available from this type, however the scheme method is redefined to always return some scheme.

Example

let iri = Iri::new("https://www.rust-lang.org/foo/bar?query#frag")?;

println!("scheme: {}", iri.scheme()); // note the absence of `unwrap` here since
                                      // the scheme is always defined in an IRI.
println!("authority: {}", iri.authority().unwrap());
println!("path: {}", iri.path());
println!("query: {}", iri.query().unwrap());
println!("fragment: {}", iri.fragment().unwrap());

Implementations

impl<'a> Iri<'a>

pub fn new<S: AsRef<[u8]> + ?Sized>(buffer: &'a S) -> Result<Iri<'a>, Error>

Create a new IRI slice from a bytes slice.

This may fail if the source slice is not UTF-8 encoded, or is not a valid IRI.

pub const fn from_iri_ref(iri_ref: IriRef<'a>) -> Iri<'a>

Build an IRI from an IRI reference.

pub fn as_iri_ref(&self) -> IriRef<'a>

Get an IriRef out of this IRI.

An IRI is always a valid IRI-reference.

pub fn scheme(&self) -> Scheme<'_>

Get the scheme of the IRI.

Contrarily to IriRef, the scheme of an IRI is always defined.

Methods from Deref<Target = IriRef<'a>>

pub fn parsing_data(&self) -> ParsedIriRef

Get the underlying parsing data.

pub fn len(&self) -> usize

Get the length is the IRI-reference, in bytes.

pub fn as_ref(&self) -> &[u8]

Get a reference to the underlying bytes slice representing the IRI-reference.

pub fn as_str(&self) -> &str

Get the IRI-reference as a string slice.

pub fn as_pct_str(&self) -> &PctStr

Get the IRI-reference as a percent-encoded string slice.

pub fn scheme(&self) -> Option<Scheme<'_>>

Get the scheme of the IRI-reference.

The scheme is located at the very begining of the IRI-reference and delimited by an ending :.

Example

assert_eq!(IriRef::new("foo://example.com:8042").unwrap().scheme().unwrap(), "foo");
assert_eq!(IriRef::new("//example.com:8042").unwrap().scheme(), None);

pub fn authority(&self) -> Option<Authority<'_>>

Get the authority of the IRI-reference.

The authority is delimited by the // string, after the scheme.

Example

assert_eq!(IriRef::new("foo://example.com:8042").unwrap().authority().unwrap().host(), "example.com");
assert_eq!(IriRef::new("foo:").unwrap().authority(), None);

pub fn path(&'a self) -> Path<'a>

Get the path of the IRI-reference.

The path is located just after the authority. It is always defined, even if empty.

Example

assert_eq!(IriRef::new("foo:/a/b/c?query").unwrap().path(), "/a/b/c");
assert!(IriRef::new("foo:#fragment").unwrap().path().is_empty());

pub fn query(&self) -> Option<Query<'_>>

Get the query of the IRI-reference.

The query part is delimited by the ? character after the path.

Example

assert_eq!(IriRef::new("//example.org?query").unwrap().query().unwrap(), "query");
assert!(IriRef::new("//example.org/foo/bar#fragment").unwrap().query().is_none());

pub fn fragment(&self) -> Option<Fragment<'_>>

Get the fragment of the IRI-reference.

The fragment part is delimited by the # character after the query.

Example

assert_eq!(IriRef::new("//example.org#foo").unwrap().fragment().unwrap(), "foo");
assert!(IriRef::new("//example.org").unwrap().fragment().is_none());

pub fn resolved<'b, Base: Into<Iri<'b>>>(&self, base_iri: Base) -> IriBuf

Resolve the IRI reference against the given base IRI.

Return the resolved IRI. See the IriRefBuf::resolve method for more informations about the resolution process.

pub fn suffix<'b, Prefix: Into<IriRef<'b>>>(
    &self,
    prefix: Prefix
) -> Option<(PathBuf, Option<Query<'_>>, Option<Fragment<'_>>)>

Get the suffix of this IRI reference, if any, with regard to the given prefix IRI reference..

Returns Some((suffix, query, fragment)) if this IRI reference is of the form prefix/suffix?query#fragment where prefix is given as parameter. Returns None otherwise. If the suffix scheme or authority is different from this path, it will return None.

See Path::suffix for more details.

pub fn base(&self) -> IriRef<'_>

The IRI reference without the file name, query and fragment.

Example

let a = IriRef::new("https://crates.io/crates/iref?query#fragment").unwrap();
let b = IriRef::new("https://crates.io/crates/iref/?query#fragment").unwrap();
assert_eq!(a.base(), "https://crates.io/crates/");
assert_eq!(b.base(), "https://crates.io/crates/iref/")

pub fn relative_to<'b, Other: Into<IriRef<'b>>>(
    &self,
    other: Other
) -> IriRefBuf

Get this IRI reference relatively to the given one.

Example

let a = IriRef::new("https://crates.io/").unwrap();
let b = IriRef::new("https://crates.io/crates/iref").unwrap();
let c = IriRef::new("https://crates.io/crates/json-ld").unwrap();
assert_eq!(b.relative_to(a), "crates/iref");
assert_eq!(a.relative_to(b), "https://crates.io/");
assert_eq!(b.relative_to(c), "iref");
assert_eq!(c.relative_to(b), "json-ld");

Trait Implementations

impl<'a> AsIri for Iri<'a>

fn as_iri(&self) -> Iri<'_>

impl<'a> AsIriRef for Iri<'a>

fn as_iri_ref(&self) -> IriRef<'_>

impl<'a> Clone for Iri<'a>

fn clone(&self) -> Iri<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Iri<'a>

impl<'a> Debug for Iri<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Iri<'a>

type Target = IriRef<'a>

The resulting type after dereferencing.

fn deref(&self) -> &IriRef<'a>

Dereferences the value.

impl<'a> Display for Iri<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Iri<'a>

impl<'a> From<&'a Iri<'a>> for IriBuf

fn from(iri: &'a Iri<'a>) -> IriBuf

Performs the conversion.

impl<'a> From<&'a Iri<'a>> for IriRefBuf

fn from(iri: &'a Iri<'a>) -> IriRefBuf

Performs the conversion.

impl<'a> From<&'a IriBuf> for Iri<'a>

fn from(buffer: &'a IriBuf) -> Iri<'a>

Performs the conversion.

impl<'a> From<Iri<'a>> for IriBuf

fn from(iri: Iri<'a>) -> IriBuf

Performs the conversion.

impl<'a> From<Iri<'a>> for IriRefBuf

fn from(iri: Iri<'a>) -> IriRefBuf

Performs the conversion.

impl<'a> From<Iri<'a>> for IriRef<'a>

fn from(iri: Iri<'a>) -> IriRef<'a>

Performs the conversion.

impl<'a> Hash for Iri<'a>

fn hash<H: Hasher>(&self, hasher: &mut H)

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<'a> Ord for Iri<'a>

fn cmp(&self, other: &Iri<'a>) -> 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<'a> PartialEq<&'a str> for Iri<'a>

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Iri<'a>> for IriBuf

fn eq(&self, other: &Iri<'a>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Iri<'a>> for Iri<'a>

fn eq(&self, other: &Iri<'_>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Iri<'a>> for IriRefBuf

fn eq(&self, iri: &Iri<'a>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<Iri<'a>> for IriRef<'a>

fn eq(&self, other: &Iri<'a>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<IriBuf> for Iri<'a>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<IriRef<'a>> for Iri<'a>

fn eq(&self, other: &IriRef<'a>) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialEq<IriRefBuf> for Iri<'a>

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> PartialOrd<Iri<'a>> for IriBuf

fn partial_cmp(&self, other: &Iri<'a>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<Iri<'a>> for Iri<'a>

fn partial_cmp(&self, other: &Iri<'a>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<Iri<'a>> for IriRefBuf

fn partial_cmp(&self, other: &Iri<'a>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<Iri<'a>> for IriRef<'a>

fn partial_cmp(&self, other: &Iri<'a>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<IriBuf> for Iri<'a>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<IriRef<'a>> for Iri<'a>

fn partial_cmp(&self, other: &IriRef<'a>) -> Option<Ordering>

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> PartialOrd<IriRefBuf> for Iri<'a>

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]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<'a> TryFrom<&'a IriRefBuf> for Iri<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(buffer: &'a IriRefBuf) -> Result<Iri<'a>, Error>

Performs the conversion.

impl<'a> TryFrom<IriRef<'a>> for Iri<'a>

type Error = IriRef<'a>

The type returned in the event of a conversion error.

fn try_from(iri_ref: IriRef<'a>) -> Result<Iri<'a>, IriRef<'a>>

Performs the conversion.