Struct InternedHash

pub struct InternedHash<T: ?Sized + Eq + Hash>(/* private fields */);

An interned value

This type works very similar to an Arc with the difference that it has no concept of weak references. They are not needed because interned values must not be modified, so reference cycles cannot be constructed. One reference is held by the interner that created this value as long as that interner lives.

Keeping interned values around does not keep the interner alive: once the last reference to the interner is dropped, it will release its existing references to interned values by dropping its set implementation. Only the direct allocation size of the set implementation remains allocated (but no longer functional) until the last weak reference to the interner goes away — each interned value keeps one such weak reference to its interner.

Implementations

impl<T: ?Sized + Eq + Hash> InternedHash<T>

pub fn ref_count(&self) -> u32

Obtain current number of references, including this one.

The value will always be at least 1. If the value is 1, this means that the interner which produced this reference has been dropped; in this case you are still free to use this reference in any way you like.

Trait Implementations

impl<T: ?Sized + Eq + Hash> AsRef<T> for InternedHash<T>

fn as_ref(&self) -> &T

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

impl<T: ?Sized + Eq + Hash> Borrow<T> for InternedHash<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: ?Sized + Eq + Hash> Clone for InternedHash<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for InternedHash<T>

where T: Debug + ?Sized + Eq + Hash,

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

Formats the value using the given formatter.

impl<T: ?Sized + Eq + Hash> Deref for InternedHash<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> Display for InternedHash<T>

where T: Display + ?Sized + Eq + Hash,

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

Formats the value using the given formatter.

impl<T> Hash for InternedHash<T>

where T: Hash + ?Sized + Eq,

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> Ord for InternedHash<T>

where T: Ord + ?Sized + Eq + Hash,

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<T> PartialEq for InternedHash<T>

where T: PartialEq + ?Sized + Eq + Hash,

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> PartialOrd for InternedHash<T>

where T: PartialOrd + ?Sized + Eq + Hash,

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<T: ?Sized + Eq + Hash> Pointer for InternedHash<T>

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

Formats the value using the given formatter.

impl<T> Eq for InternedHash<T>

where T: Eq + ?Sized + Hash,