Struct Intern

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

A reference to an interned item.

The main advantage of this type over just an immutable reference is that its pointer is guaranteed to be unique within a single Interner. Therefore comparisons are very cheap.

Note about hashing

This wrapper implements PartialEq by comparing its inner pointer. In order to keep consistency, the Hash trait is also implemented by hashing the pointer, NOT the inner value. Therefore hashes of the Intern<T> type are different than hashes of the T.

Implementations

impl<'a, T> Intern<'a, T>

pub unsafe fn from_raw(ptr: *const T) -> Self

Create a new Intern type from a raw pointer.

Safety

The caller must guarantee that the pointed value is in fact owned by an Interner which is still in scope (i.e. not dropped) and that the pointer will not be mutated and/or moved.

Trait Implementations

impl<'a, T> AsRef<T> for Intern<'a, T>

fn as_ref(&self) -> &T

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

impl<'a, T> Borrow<T> for Intern<'a, T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<'a, T> Clone for Intern<'a, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for Intern<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for Intern<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Display> Display for Intern<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Hash for Intern<'a, T>

To keep consistency with PartialEq, we hash the pointer, not the value

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> Ord for Intern<'a, T>

fn cmp(&self, other: &Self) -> 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<'a, T> PartialEq for Intern<'a, 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<'a, T: PartialOrd> PartialOrd for Intern<'a, T>

fn partial_cmp(&self, other: &Self) -> 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<'a, T> Copy for Intern<'a, T>

impl<'a, T> Eq for Intern<'a, T>