Struct Iri

pub struct Iri<T>(/* private fields */)
where
    T: Borrow<str>;

See Iri::new.

Implementations

impl<T> Iri<T>

where T: Borrow<str>,

pub fn new(iri: T) -> Result<Iri<T>, InvalidIri>

This wrapper guarantees that the underlying str satisfies the IRI rule in RFC-3687 (i.e. an absolute IRI with an optional fragment).

pub fn as_str(&self) -> &str

Gets a reference to the underlying &str.

pub fn resolve<U>(&self, rel: U) -> Iri<String>

where U: IsIriRef,

Resolve a relative IRI reference against this one.

NB: when resolving multiple IRI references against the same base, it is preferable to first turn it into a BaseIri, with the Iri::as_base or Iri::to_base methods.

pub fn as_base(&self) -> BaseIri<&str>

Borrow this IRI as a BaseIri providing more efficient and flexible resolution methods than Iri::resolve.

pub fn to_base(self) -> BaseIri<T>

where T: Deref<Target = str>,

Turn this IRI into a BaseIri providing more efficient and flexible resolution methods than Iri::resolve.

pub fn new_unchecked(inner: T) -> Iri<T>

Construct a Iri<T> without checking that the inner value is valid. If it is not, it may result in undefined behaviour.

pub fn unwrap(self) -> T

Returns the wrapped value, consuming self.

pub fn map_unchecked<F, U>(self, f: F) -> Iri<U>

where F: FnOnce(T) -> U, U: Borrow<str>,

Map a Iri<T> to a Iri<U> by applying a function to the wrapped value. It does not check that the value returned by the function is valid. If it is not, it may result in undefined behaviour.

impl<T> Iri<T>

where T: Borrow<str>,

pub fn as_ref(&self) -> Iri<&str>

Convert from &Iri<T> to Iri<&str>.

impl Iri<&'static str>

pub const fn new_unchecked_const(inner: &'static str) -> Iri<&'static str>

Construct a Iri<&'static str> without checking that the inner value is valid. If it is not, it may result in undefined behaviour.

Trait Implementations

impl<T> AsRef<T> for Iri<T>

where T: Borrow<str>,

fn as_ref(&self) -> &T

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

impl<T> AsRef<str> for Iri<T>

where T: Borrow<str>,

fn as_ref(&self) -> &str

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

impl<T> Borrow<T> for Iri<T>

where T: Borrow<str>,

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> Borrow<str> for Iri<T>

where T: Borrow<str>,

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl<T> Clone for Iri<T>

where T: Clone + Borrow<str>,

fn clone(&self) -> Iri<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Iri<T>

where T: Debug + Borrow<str>,

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

Formats the value using the given formatter.

impl<'a, T> Deserialize<'a> for Iri<T>

where T: Borrow<str> + Deserialize<'a>,

fn deserialize<D>( deserializer: D, ) -> Result<Iri<T>, <D as Deserializer<'a>>::Error>

where D: Deserializer<'a>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Iri<T>

where T: Borrow<str>,

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

Formats the value using the given formatter.

impl<T> Hash for Iri<T>

where T: Borrow<str> + Hash,

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Iri<T>

where T: Borrow<str> + Eq + Ord,

fn cmp(&self, rhs: &Iri<T>) -> 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,

Restrict a value to a certain interval.

impl<T, U> PartialEq<Iri<T>> for Iri<U>

where T: Borrow<str>, U: Borrow<str> + PartialEq<T>,

fn eq(&self, rhs: &Iri<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq<Iri<T>> for str

where T: Borrow<str>, str: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> PartialEq<str> for Iri<T>

where T: Borrow<str>, str: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T, U> PartialOrd<Iri<T>> for Iri<U>

where T: Borrow<str>, U: Borrow<str> + PartialOrd<T>,

fn partial_cmp(&self, rhs: &Iri<T>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> PartialOrd<Iri<T>> for str

where T: Borrow<str>, str: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> PartialOrd<str> for Iri<T>

where T: Borrow<str>, str: PartialOrd,

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T> Serialize for Iri<T>

where T: Borrow<str>,

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<T> Term for Iri<T>

where T: Borrow<str> + Debug,

type BorrowTerm<'x> = &'x Iri<T> where T: 'x

A type of Term that can be borrowed from this type (i.e. that can be obtained from a simple reference to this type). It is used in particular for accessing constituents of quoted tripes (Term::triple) or for sharing this term with a function that expects T: Term (rather than &T) using Term::borrow_term.

fn kind(&self) -> TermKind

Return the kind of RDF term that this Term represents.

fn iri(&self) -> Option<IriRef<MownStr<'_>>>

If kind returns TermKind::Iri, return this IRI. Otherwise return None.

fn borrow_term(&self) -> Self::BorrowTerm<'_>

Get something implementing Term from a simple reference to self, representing the same RDF term as self.

fn is_iri(&self) -> bool

Return true if this Term is an IRI, i.e. if kind retuns TermKind::Iri.

fn is_blank_node(&self) -> bool

Return true if this Term is a blank node, i.e. if kind retuns TermKind::BlankNode.

fn is_literal(&self) -> bool

Return true if this Term is a literal, i.e. if kind retuns TermKind::Literal.

fn is_variable(&self) -> bool

Return true if this Term is a variable, i.e. if kind retuns TermKind::Variable.

fn is_atom(&self) -> bool

Return true if this Term is an atomic term, i.e. an IRI, a blank node, a literal or a variable.

fn is_triple(&self) -> bool

Return true if this Term is an RDF-star quoted triple, i.e. if kind retuns TermKind::Triple.

fn bnode_id(&self) -> Option<BnodeId<MownStr<'_>>>

If kind returns TermKind::BlankNode, return the locally unique label of this blank node. Otherwise return None.

fn lexical_form(&self) -> Option<MownStr<'_>>

If kind returns TermKind::Literal, return the lexical form of this literal. Otherwise return None.

fn datatype(&self) -> Option<IriRef<MownStr<'_>>>

If kind returns TermKind::Literal, return the datatype IRI of this literal. Otherwise return None.

fn language_tag(&self) -> Option<LanguageTag<MownStr<'_>>>

If kind returns TermKind::Literal, and if this literal is a language-tagged string, return its language tag. Otherwise return None.

fn variable(&self) -> Option<VarName<MownStr<'_>>>

If kind returns TermKind::Variable, return the name of this variable. Otherwise return None.

fn triple(&self) -> Option<[Self::BorrowTerm<'_>; 3]>

If kind returns TermKind::Triple, return this triple. Otherwise return None.

fn to_triple(self) -> Option<[Self; 3]>

where Self: Sized,

If kind returns TermKind::Triple, return this triple, consuming this term. Otherwise return None.

fn constituents<'s>( &'s self, ) -> Box<dyn Iterator<Item = Self::BorrowTerm<'s>> + 's>

Iter over all the constituents of this term.

fn to_constituents<'a>(self) -> Box<dyn Iterator<Item = Self> + 'a>

where Self: Clone + 'a,

Iter over all the constiutents of this term, consuming it.

fn atoms<'s>(&'s self) -> Box<dyn Iterator<Item = Self::BorrowTerm<'s>> + 's>

Iter over all the atomic constituents of this term.

fn to_atoms<'a>(self) -> Box<dyn Iterator<Item = Self> + 'a>

where Self: Sized + 'a,

Iter over all the atomic constituents of this term, consuming it.

fn eq<T: Term>(&self, other: T) -> bool

Check whether self and other represent the same RDF term.

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

where T: Term,

Compare two terms:

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

Compute an implementation-independant hash of this RDF term.

fn into_term<T: FromTerm>(self) -> T

where Self: Sized,

Convert this term in another type.

fn try_into_term<T: TryFromTerm>(self) -> Result<T, T::Error>

where Self: Sized,

Try to convert this term into another type.

fn as_simple(&self) -> SimpleTerm<'_>

Copies this term into a SimpleTerm, borrowing as much as possible from self (calling SimpleTerm::from_term_ref).

impl<T> Deref for Iri<T>

where T: Borrow<str>,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T> Copy for Iri<T>

where T: Copy + Borrow<str>,

impl<T> Eq for Iri<T>

where T: Borrow<str> + Eq,

impl<T> IsIri for Iri<T>

where T: Borrow<str>,

impl<T> IsIriRef for Iri<T>

where T: Borrow<str>,