Struct Id 

pub struct Id { /* private fields */ }

Represents a unique abstract 128 bit identifier. As we do not allow for all zero nil IDs, Option<Id> benefits from Option nieche optimizations.

Note that it has an alignment of 1, and can be referenced as a [u8; 16] RawId.

Implementations

impl Id

pub const fn new(id: RawId) -> Option<Self>

Creates a new Id from a RawId 16 byte array.

pub fn from_hex(hex: &str) -> Option<Self>

Parses a hexadecimal identifier string into an Id.

Returns None if the input is not valid hexadecimal or represents the nil identifier (all zero bytes).

pub const unsafe fn force(id: RawId) -> Self

Forces the creation of an Id from a RawId without checking for nil.

Safety

The caller must ensure that id is not the nil value of all zero bytes.

pub fn as_transmute_raw(id: &RawId) -> Option<&Self>

Transmutes a reference to a RawId into a reference to an Id. Returns None if the referenced RawId is nil (all zero).

pub fn acquire(&self) -> Option<ExclusiveId>

Takes ownership of this Id from the current write context (i.e. thread). Returns None if this Id was not found, because it is not associated with this write context, or because it is currently acquired.

pub const fn raw(self) -> RawId

Returns the raw 16-byte representation of this identifier.

This is const so schema identifiers can be composed at compile time.

Trait Implementations

impl AsRef<Id> for ExclusiveId

fn as_ref(&self) -> &Id

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

impl AsRef<Id> for OwnedId<'_>

fn as_ref(&self) -> &Id

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

impl AsRef<[u8; 16]> for Id

fn as_ref(&self) -> &RawId

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

impl AsRef<[u8]> for Id

fn as_ref(&self) -> &[u8]

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

impl Borrow<Id> for ExclusiveId

fn borrow(&self) -> &Id

Immutably borrows from an owned value.

impl Borrow<Id> for OwnedId<'_>

fn borrow(&self) -> &Id

Immutably borrows from an owned value.

impl Borrow<[u8; 16]> for Id

fn borrow(&self) -> &RawId

Immutably borrows from an owned value.

impl Clone for Id

fn clone(&self) -> Id

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Id

impl Debug for Id

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

Formats the value using the given formatter.

impl Deref for Id

type Target = [u8; 16]

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Id

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

Formats the value using the given formatter.

impl Encodes<&Id> for GenId

type Output = Inline<GenId>

The concrete form this source produces when encoded for this schema. Inline<Self> for inline encodings, Blob<Self> for blob encodings, or Inline<Handle<Self>> for the precomputed-handle case where Self: BlobEncoding.

fn encode(source: &Id) -> Inline<GenId>

Run the encoding.

impl Encodes<Id> for GenId

type Output = Inline<GenId>

The concrete form this source produces when encoded for this schema. Inline<Self> for inline encodings, Blob<Self> for blob encodings, or Inline<Handle<Self>> for the precomputed-handle case where Self: BlobEncoding.

fn encode(source: Id) -> Inline<GenId>

Run the encoding.

impl Eq for Id

impl From<Id> for RawId

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<Id> for RawInline

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<Id> for Uuid

fn from(id: Id) -> Self

Converts to this type from the input type.

impl Hash for 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 LowerHex for Id

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

Formats the value using the given formatter.

impl Ord for Id

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 PartialEq for Id

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

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 StructuralPartialEq for Id

impl TryFrom<Uuid> for Id

type Error = NilUuidError

The type returned in the event of a conversion error.

fn try_from(id: Uuid) -> Result<Self, NilUuidError>

Performs the conversion.

impl TryFromInline<'_, GenId> for Id

type Error = IdParseError

The error type returned when the conversion fails.

fn try_from_inline(value: &Inline<GenId>) -> Result<Self, Self::Error>

Convert the Inline with a specific schema type to the Rust type.

impl<'a> TryFromInline<'a, GenId> for &'a Id

type Error = IdParseError

The error type returned when the conversion fails.

fn try_from_inline(value: &'a Inline<GenId>) -> Result<Self, Self::Error>

Convert the Inline with a specific schema type to the Rust type.

impl UpperHex for Id

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

Formats the value using the given formatter.