Skip to main content

StableId

Struct StableId 

Source
pub struct StableId<Kind: StableIdKind> { /* private fields */ }
Expand description

A 16-byte stable identifier, parameterized by role tag.

Construct via StableId::new_v7 for fresh IDs or StableId::from_bytes to rehydrate from canonical-encoded form.

Two StableId values with different role tags are distinct types and cannot be compared or converted without an explicit crossing.

Implementations§

Source§

impl<Kind: StableIdKind> StableId<Kind>

Source

pub fn new_v7() -> Self

Generate a fresh UUIDv7 stable ID.

Uses the uuid crate’s Uuid::now_v7(), which combines the current Unix timestamp (48 bits, millisecond resolution) with 74 bits of CSPRNG entropy. See RFC 9562.

Source

pub const fn from_bytes_raw(bytes: [u8; 16]) -> Self

Construct from an explicit 16-byte array. The bytes are not validated beyond their length - any 128-bit value is accepted. Callers who want UUID shape validation should use StableId::parse_uuid.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, IdError>

Construct from a byte slice of length 16, validating the length.

§Errors

Returns IdError::StableIdLength if bytes.len() != 16.

Source

pub fn parse_uuid(s: &str) -> Result<Self, IdError>

Parse from a canonical UUID string (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

§Errors

Returns IdError::StableIdParse if s is not a valid UUID.

Source

pub const fn from_random_bytes(bytes: [u8; 16]) -> Self

Construct from 16 random bytes without UUID structure. Useful when the caller has already generated cryptographically random bytes and does not need UUIDv7’s time ordering. The value will not validate as a UUIDv7 but will still function as a stable ID in mnem.

Source

pub const fn as_bytes(&self) -> &[u8; 16]

Borrow as a byte slice.

Source

pub const fn into_bytes(self) -> [u8; 16]

Consume and return the underlying 16 bytes.

Source

pub fn to_uuid_string(&self) -> String

Render as a lowercase hyphenated UUID string.

Trait Implementations§

Source§

impl<Kind: Clone + StableIdKind> Clone for StableId<Kind>

Source§

fn clone(&self) -> StableId<Kind>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Kind: StableIdKind> Debug for StableId<Kind>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, Kind: StableIdKind> Deserialize<'de> for StableId<Kind>

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<Kind: StableIdKind> Display for StableId<Kind>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<StableId<ChangeTag>> for ProllyKey

Source§

fn from(v: ChangeId) -> Self

Converts to this type from the input type.
Source§

impl From<StableId<EdgeTag>> for ProllyKey

Source§

fn from(v: EdgeId) -> Self

Converts to this type from the input type.
Source§

impl From<StableId<NodeTag>> for ProllyKey

Source§

fn from(v: NodeId) -> Self

Converts to this type from the input type.
Source§

impl<Kind: Hash + StableIdKind> Hash for StableId<Kind>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<Kind: Ord + StableIdKind> Ord for StableId<Kind>

Source§

fn cmp(&self, other: &StableId<Kind>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<Kind: PartialEq + StableIdKind> PartialEq for StableId<Kind>

Source§

fn eq(&self, other: &StableId<Kind>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Kind: PartialOrd + StableIdKind> PartialOrd for StableId<Kind>

Source§

fn partial_cmp(&self, other: &StableId<Kind>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<Kind: StableIdKind> Serialize for StableId<Kind>

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl<Kind: Copy + StableIdKind> Copy for StableId<Kind>

Source§

impl<Kind: Eq + StableIdKind> Eq for StableId<Kind>

Source§

impl<Kind: StableIdKind> StructuralPartialEq for StableId<Kind>

Auto Trait Implementations§

§

impl<Kind> Freeze for StableId<Kind>

§

impl<Kind> RefUnwindSafe for StableId<Kind>

§

impl<Kind> Send for StableId<Kind>

§

impl<Kind> Sync for StableId<Kind>

§

impl<Kind> Unpin for StableId<Kind>

§

impl<Kind> UnsafeUnpin for StableId<Kind>

§

impl<Kind> UnwindSafe for StableId<Kind>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,