Enum mz_ore::id_gen::IdHandle

pub enum IdHandle<T, A: IdAllocatorInner> {
    Static(T),
    Dynamic(Arc<IdHandleInner<T, A>>),
}

A clone-able owned reference to an ID.

Once all of the IdHandles referencing an ID have been dropped, we will then free the ID for later re-use.

Variants

Static(T)

An ID “allocated” at compile time.

Note: It is entirely up to the caller to make sure the provided ID is not used by a dynamic ID allocator.

Dynamic(Arc<IdHandleInner<T, A>>)

An ID allocated at runtime, gets freed once all handles have been dropped.

Implementations

impl<T: IdGenerator, A: IdAllocatorInner> IdHandle<T, A>

pub fn unhandled(&self) -> T

Returns the raw ID inside of this handle.

Use with caution! It is easy for a raw ID to outlive the handle from which it came. You are responsible for ensuring that your use of the raw ID does not lead to ID reuse bugs.

Trait Implementations

impl<T, A: IdAllocatorInner> Borrow<T> for IdHandle<T, A>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Clone, A: IdAllocatorInner> Clone for IdHandle<T, A>

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, A: Debug + IdAllocatorInner> Debug for IdHandle<T, A>

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

Formats the value using the given formatter.

impl<T: IdGenerator, A: IdAllocatorInner> Display for IdHandle<T, A>

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

Formats the value using the given formatter.

impl<T: IdGenerator, A: IdAllocatorInner> Ord for IdHandle<T, A>

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 + PartialOrd,

Restrict a value to a certain interval.

impl<T: IdGenerator, A: IdAllocatorInner> PartialEq for IdHandle<T, A>

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: IdGenerator, A: IdAllocatorInner> PartialOrd for IdHandle<T, A>

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: IdGenerator, A: IdAllocatorInner> Serialize for IdHandle<T, A>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: IdGenerator, A: IdAllocatorInner> Eq for IdHandle<T, A>