Struct iref::IriRefBuf

pub struct IriRefBuf { /* fields omitted */ }

Owned IRI-reference.

Holds a mutable buffer representing an IRI-reference. This type can be used to create and/or modify existing IRI-references. The authority and path can be accessed mutabily to modify their sub-components.

Example

let mut iri = IriBuf::new("https://www.rust-lang.org")?;

iri.authority_mut().unwrap().set_port(Some("40".try_into()?));
iri.set_path("/foo".try_into()?);
iri.path_mut().push("bar".try_into()?);
iri.set_query(Some("query".try_into()?));
iri.set_fragment(Some("fragment".try_into()?));

assert_eq!(iri, "https://www.rust-lang.org:40/foo/bar?query#fragment");

See the IriRef type for more informations about IRI-references.

Methods

impl IriRefBuf

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

pub fn as_iri_ref(&self) -> IriRef

pub fn as_iri(&self) -> Result<Iri, Error>

pub fn len(&self) -> usize

Length in bytes.

pub fn as_str(&self) -> &str

pub fn as_pct_str(&self) -> &PctStr

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

pub fn set_scheme(&mut self, scheme: Option<Scheme>)

Set the scheme of the IRI.

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

pub fn authority_mut(&mut self) -> Option<AuthorityMut>

pub fn set_authority(&mut self, authority: Option<Authority>)

Set the authority of the IRI.

It must be a syntactically correct authority. If not, this method returns an error, and the IRI is unchanged.

pub fn path(&self) -> Path

pub fn path_mut(&mut self) -> PathMut

pub fn set_path(&mut self, path: Path)

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

pub fn set_query(&mut self, query: Option<Query>)

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

pub fn set_fragment(&mut self, fragment: Option<Fragment>)

pub fn resolve<'b, Base: Into<Iri<'b>>>(&mut self, base_iri: Base)

Resolve the IRI reference.

Abnormal use of dot segments.

https://www.rfc-editor.org/errata/eid4547

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

Trait Implementations

impl Clone for IriRefBuf

fn clone(&self) -> IriRefBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IriRefBuf

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

Formats the value using the given formatter.

impl Default for IriRefBuf

fn default() -> IriRefBuf

Returns the "default value" for a type.

impl Display for IriRefBuf

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

Formats the value using the given formatter.

impl Eq for IriRefBuf

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

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

Performs the conversion.

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

fn from(iri_ref: &'a IriRef<'a>) -> IriRefBuf

Performs the conversion.

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

fn from(iri_ref_buf: &'a IriRefBuf) -> IriRef<'a>

Performs the conversion.

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

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

Performs the conversion.

impl From<IriBuf> for IriRefBuf

fn from(iri: IriBuf) -> IriRefBuf

Performs the conversion.

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

fn from(iri_ref: IriRef<'a>) -> IriRefBuf

Performs the conversion.

impl Hash for IriRefBuf

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 Ord for IriRefBuf

fn cmp(&self, other: &IriRefBuf) -> 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 IriRefBuf

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 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 PartialEq<IriBuf> for IriRefBuf

fn eq(&self, iri: &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 IriRefBuf

fn eq(&self, iri_ref: &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 PartialEq<IriRefBuf> for IriBuf

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> 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 PartialEq<IriRefBuf> for IriRefBuf

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> PartialEq<IriRefBuf> for IriRef<'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 PartialEq<str> for IriRefBuf

fn eq(&self, other: &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> 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 PartialOrd<IriBuf> for IriRefBuf

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 IriRefBuf

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 PartialOrd<IriRefBuf> for IriBuf

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> 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 PartialOrd<IriRefBuf> for IriRefBuf

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> PartialOrd<IriRefBuf> for IriRef<'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 TryFrom<IriRefBuf> for IriBuf

type Error = IriRefBuf

The type returned in the event of a conversion error.

fn try_from(iri_ref: IriRefBuf) -> Result<IriBuf, IriRefBuf>

Performs the conversion.