Struct Ref 

pub(crate) struct Ref<K: Key> {
    raw_key: K,
    marker: PhantomData<K>,
    bomb: DropBombCondition,
}

An copy of a slotmap_careful::Key K, which is counted by a RefCount

Ie, a key of type K with the property that it keeps the refcounted data structure alive.

Must always be deleted using dispose, not dropped. In tests, dropping a RefCounted will panic.

The Default value does not contribute to a reference count, and is fine to drop.

Fields

raw_key: K

Actual key (without generics)

marker: PhantomData<K>

Bind to the specific key type

bomb: DropBombCondition

Drop bomb

Also forces Ref not to be Clone

Implementations

impl<K: Key> Ref<K>

pub(crate) fn new(key: K, count: &mut Count<K>) -> Result<Self, Overflow>

Create a refcounted reference Ref from an un-counted key, incrementing the count

pub(crate) fn null() -> Self

Creates a null Ref, which doesn’t refer to any slot (lookups always give None)

fn from_raw(raw_key: K) -> Self

Internal function for creating a Ref

pub(crate) fn dispose(self, refcount: &mut Count<K>) -> Option<Garbage<K>>

Dispose of a refcounted reference Ref, decrementing the count

If the count reaches zero, the raw key is returned; the caller should remove the corresponding data from the data structure.

pub(crate) fn dispose_container_destroyed(self)

Dispose of a refcounted reference whose container no longer exists

CORRECTNESS

This just forgets the reference, without decrementing any refcount. If the container does still exist, a ref count ref will be leaked.

Trait Implementations

impl<K: Key> Debug for Ref<K>

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

Formats the value using the given formatter.

impl<K: Key> Default for Ref<K>

fn default() -> Self

Returns the “default value” for a type.

impl<K: Key> DefaultExtTake for Ref<K>

fn take(&mut self) -> Self

Returns *self, replacing it with the default value.

impl<K: Key> Deref for Ref<K>

type Target = K

The resulting type after dereferencing.

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

Dereferences the value.

impl<K: Key> Ord for Ref<K>

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<K: Key> PartialEq for Ref<K>

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<K: Key> PartialOrd for Ref<K>

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<K: Key> Eq for Ref<K>