Struct Garbage

pub(crate) struct Garbage<K>(pub(crate) K);

Something which has become garbage

Often used within Option, for clarity. Examples:

• Key whose reference count has reached zero - see Ref::dispose
• Value removed from a SlotMap - see slotmap_dec_ref!

Tuple Fields

0: K

Trait Implementations

impl<K: Clone> Clone for Garbage<K>

fn clone(&self) -> Garbage<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for Garbage<K>

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

Formats the value using the given formatter.

impl<K: Hash> Hash for Garbage<K>

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<K: Ord> Ord for Garbage<K>

fn cmp(&self, other: &Garbage<K>) -> 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<K: PartialEq> PartialEq for Garbage<K>

fn eq(&self, other: &Garbage<K>) -> 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<K: PartialOrd> PartialOrd for Garbage<K>

fn partial_cmp(&self, other: &Garbage<K>) -> 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<K: Copy> Copy for Garbage<K>

impl<K: Eq> Eq for Garbage<K>

impl<K> StructuralPartialEq for Garbage<K>