Struct intern_arc::Interned

pub struct Interned<T: ?Sized> { /* fields omitted */ }

Implementations

impl<T: ?Sized> Interned<T>

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 interned values, so the backing memory will be released once each of the interned values is no longer referenced through any Interned instances. (Interned keeps a Weak reference to the interner that created it, so it will prevent the ArcInner from being deallocated while it lives.)

pub fn ref_count(&self) -> usize

Obtain current number of references, including this one, using Ordering::Relaxed. This means that reads and writes of your code may be freely reordered around this read, there is no synchronisation with other threads.

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> AsRef<T> for Interned<T>

fn as_ref(&self) -> &T

Performs the conversion.

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 copy of the value.

pub 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: ?Sized> Drop for Interned<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: ?Sized + Eq> Eq for Interned<T>

impl<T: ?Sized + Hash> Hash for Interned<T>

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: ?Sized + Ord> Ord for Interned<T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: ?Sized + PartialEq> PartialEq<Interned<T>> for Interned<T>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ?Sized + PartialOrd> PartialOrd<Interned<T>> for Interned<T>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: ?Sized> Pointer for Interned<T>

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

Formats the value using the given formatter.

impl<T: ?Sized + Sync + Send> Send for Interned<T>

impl<T: ?Sized + Sync + Send> Sync for Interned<T>