Struct Interned

pub struct Interned<'a, T: ?Sized> { /* private fields */ }

An Interned value is one that is referentially comparable. That is, the interned value is unique in memory, simplifying its equality and hashing implementation.

Comparing Interned values via PartialOrd or Ord will still dereference to the wrapped pointers, and as such, may produce results inconsistent with PartialEq or Eq.

Implementations

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

pub fn as_ptr(interned: &Self) -> *const T

Gets the internal value as a pointer

pub fn to_ref(interned: &Self) -> &'a T

Gets the internal value as a reference with the interner’s lifetime

Trait Implementations

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: ?Sized + Debug> Debug for Interned<'_, 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) -> &Self::Target

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<T: AsRef<str>> From<T> for Interned<'static, str>

fn from(value: T) -> Self

Types which implement AsRef<str> will be stored in the global StringInterner

impl<T: ?Sized> Hash for Interned<'_, 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<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 ==.

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: ?Sized> Copy for Interned<'_, T>

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