Struct AtomId

pub struct AtomId<R> { /* private fields */ }

The type representing all the components necessary to serve as an unambiguous identifier. Atoms consist of a human-readable Unicode identifier, as well as a root field, which varies for each store implementation. For example, Git uses the oldest commit in a repositories history.

Implementations

impl<R> AtomId<R>

where for<'id> AtomId<R>: Compute<'id, R>,

pub fn construct<T>(src: &T, tag: AtomTag) -> Result<Self, T::Error>

where T: Origin<R>,

Compute an atom’s origin and construct its ID. This method takes a src type which must implement the Origin struct.

Errors

This function will return an error if the call to Origin::calculate_origin fails.

pub fn root(&self) -> &R

The root field, which serves as a derived key for the blake-3 hash used to identify the Atom in backend implementations.

impl<R> AtomId<R>

pub fn tag(&self) -> &AtomTag

Return a reference to the Atom’s Unicode identifier.

Trait Implementations

impl<T> Borrow<[u8]> for AtomId<T>

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

Immutably borrows from an owned value.

impl<R: Clone> Clone for AtomId<R>

fn clone(&self) -> AtomId<R>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'id, R: AsRef<[u8]>> Compute<'id, R> for AtomId<R>

fn compute_hash(&'id self) -> IdHash<'id, R>

Computes the BLAKE3 hash of this AtomId.

impl<R: Debug> Debug for AtomId<R>

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

Formats the value using the given formatter.

impl<R> Display for AtomId<R>

where for<'id> AtomId<R>: Compute<'id, R>,

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

Formats the value using the given formatter.

impl From<AtomId<Root>> for LockDigest

fn from(value: AtomId<Root>) -> Self

Converts to this type from the input type.

impl<R: Hash> Hash for AtomId<R>

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<R: Ord> Ord for AtomId<R>

fn cmp(&self, other: &AtomId<R>) -> 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<R: PartialEq> PartialEq for AtomId<R>

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

fn partial_cmp(&self, other: &AtomId<R>) -> 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<R> Serialize for AtomId<R>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<R: Eq> Eq for AtomId<R>

impl<R> StructuralPartialEq for AtomId<R>