Struct generativity::Id

#[repr(transparent)]
pub struct Id<'id> { /* private fields */ }

A phantomdata-like type taking a single invariant lifetime.

Used to manipulate and store the unique invariant lifetime obtained from Guard. Use guard.into() to create a new Id.

Holding Id<'id> indicates that the lifetime 'id is a trusted brand. 'id will not unify with another trusted brand lifetime unless it comes from the same original brand (i.e. the same invocation of make_guard!).

Implementations

impl<'id> Id<'id>

pub unsafe fn new() -> Self

Construct an Id with an unbounded lifetime.

You should not need to use this function; use make_guard! instead.

Safety

Id holds an invariant lifetime that must be derived from a generative brand. Using this function directly is the “I know what I’m doing” button; restrict the lifetime to a known brand immediately to avoid introducing potential unsoundness.

Trait Implementations

impl<'id> Clone for Id<'id>

fn clone(&self) -> Id<'id>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'id> Debug for Id<'id>

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

Formats the value using the given formatter.

impl<'id> From<Guard<'id>> for Id<'id>

fn from(guard: Guard<'id>) -> Self

Converts to this type from the input type.

impl<'id> Hash for Id<'id>

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<'id> Ord for Id<'id>

fn cmp(&self, other: &Id<'id>) -> 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<'id> PartialEq<Id<'id>> for Id<'id>

fn eq(&self, other: &Id<'id>) -> 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<'id> PartialOrd<Id<'id>> for Id<'id>

fn partial_cmp(&self, other: &Id<'id>) -> 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<'id> Copy for Id<'id>

impl<'id> Eq for Id<'id>

impl<'id> StructuralEq for Id<'id>

impl<'id> StructuralPartialEq for Id<'id>