Struct Interned

pub struct Interned<'a, T: ?Sized>(/* private fields */);

An item interned by an Interner.

As two equal interned items will always be the same reference, only the reference is compared for equality rather than going to the potentially expensive PartialEq implementation on the concrete type.

In all other cases, this should act exactly as if it were a reference to the wrapped type. To get the wrapped reference with the full lifetime, see Interned::get.

Implementations

impl<'a, T: ?Sized> Interned<'a, T>

pub fn get(this: &Self) -> &'a T

Get the wrapped reference out directly.

This is an associated function rather than a method in order to avoid conflicting with implementations on the concrete type.

Trait Implementations

impl<T, U> AsRef<U> for Interned<'_, T>

where T: AsRef<U> + ?Sized, U: ?Sized,

fn as_ref(&self) -> &U

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

impl<T: ?Sized> Borrow<T> for Interned<'_, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized> Clone for Interned<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + ?Sized> Debug for Interned<'a, T>

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

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Interned<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<'a, T: Hash + ?Sized> Hash for Interned<'a, T>

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

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<'a, T: Ord + ?Sized> Ord for Interned<'a, T>

fn cmp(&self, other: &Interned<'a, 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: ?Sized> PartialEq for Interned<'_, T>

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

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

const 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<'a, T: PartialOrd + ?Sized> PartialOrd for Interned<'a, T>

fn partial_cmp(&self, other: &Interned<'a, 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: ?Sized> Copy for Interned<'_, T>

impl<T: ?Sized> Eq for Interned<'_, T>