Struct unique::Uniq

pub struct Uniq<T: ?Sized>(_);

A unique pointer to data, allocated by a backing store.

By “unique” I mean that if t1 == t2 (as determined by the backing store), then Uniq::new(t1) is pointer-equal to Uniq::new(t2). This property reduces memory use, reduces allocator hits, and allows for short-circuiting many operations, including Ord (pointer ordering), Eq (pointer equality), and Hash (pointer hash).

Implementations

impl<T: Backed> Uniq<T>

pub fn new(data: T) -> Uniq<T>

Ask the backing store for a uniq’d pointer to data.

This may be newly-allocated or recycled.

Trait Implementations

impl<T> AsRef<T> for Uniq<T>

fn as_ref(&self) -> &T

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

impl<T> Borrow<T> for Uniq<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> Clone for Uniq<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: Debug> Debug for Uniq<T>

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

Formats the value using the given formatter.

impl<T> Deref for Uniq<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T: Display> Display for Uniq<T>

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

Formats the value using the given formatter.

impl<T: Backed> From<T> for Uniq<T>

fn from(t: T) -> Self

Converts to this type from the input type.

impl<T> Hash for Uniq<T>

fn hash<H: Hasher>(&self, hasher: &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 Uniq<T>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<T> PartialEq<Uniq<T>> for Uniq<T>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd<Uniq<T>> for Uniq<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

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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> Pointer for Uniq<T>

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

Formats the value using the given formatter.

impl<T> Copy for Uniq<T>

impl<T> Eq for Uniq<T>

impl<T> Send for Uniq<T>

impl<T> Sync for Uniq<T>