Struct URID 

pub struct URID<T = ()>(/* private fields */)
where
    T: ?Sized;

Representation of a URI for fast comparisons.

A URID is basically a number which represents a URI, which makes the identification of other features faster and easier. The mapping of URIs to URIDs is handled by a something that implements the Map trait. A given URID can also be converted back to a URI with an implementation of the Unmap trait. However, these implementations should obviously be linked.

This struct has an optional type parameter T which defaults to (). In this case, the type can represent any URID at all, but if T is a UriBound, the instance of URID<T> can only describe the URID of the given bound. This makes creation easier and also turns it into an atomic URIDCollection, which can be used to build bigger collections.

Implementations

impl URID

pub fn new(raw_urid: u32) -> Option<URID>

Creates a new URID from a raw number.

URIDs may never be zero. If the given number is zero, None is returned.

impl<T> URID<T>

where T: ?Sized,

pub unsafe fn new_unchecked(raw_urid: u32) -> URID<T>

Create a URID without checking for type or value validity.

This value may only be a URID the mapper actually produced and that is recognised by a compatible unmapper. Therefore, it should only be used by Map::map_uri or Map::map_type.

Safety

A URID may not be 0 since this value is reserved for the None value of Option<URID<T>>, which therefore has the same size as a URID<T>. If T is also a URI bound, the URID may only be the one that is mapped to the bounded URI.

Since these constraints aren’t checked by this method, it is unsafe. Using this method is technically sound as long as raw_urid is not zero, but might still result in bad behaviour if its the wrong URID for the bound T.

pub fn get(self) -> u32

Return the raw URID number.

pub fn into_general(self) -> URID

Transform the type-specific URID into a generalized one.

Trait Implementations

impl<T> Clone for URID<T>

where T: ?Sized,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for URID<T>

where T: ?Sized,

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

Formats the value using the given formatter.

impl<T> Hash for URID<T>

where T: ?Sized,

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 URID<T>

where T: ?Sized,

fn cmp(&self, other: &URID<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<T1, T2> PartialEq<URID<T1>> for URID<T2>

where T1: ?Sized, T2: ?Sized,

fn eq(&self, other: &URID<T1>) -> 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<u32> for URID<T>

where T: ?Sized,

fn eq(&self, other: &u32) -> 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<T1, T2> PartialOrd<URID<T1>> for URID<T2>

where T1: ?Sized, T2: ?Sized,

fn partial_cmp(&self, other: &URID<T1>) -> 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<u32> for URID<T>

where T: ?Sized,

fn partial_cmp(&self, other: &u32) -> 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 TryFrom<u32> for URID

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<URID, ()>

Performs the conversion.

impl<T> URIDCollection for URID<T>

where T: UriBound + ?Sized,

fn from_map<M>(map: &M) -> Option<URID<T>>

where M: Map + ?Sized,

Construct the collection from the mapper.

impl<T> Copy for URID<T>

where T: ?Sized,

impl<T> Eq for URID<T>

where T: ?Sized,