Struct Reference 

pub struct Reference(/* private fields */);

A globally unique reference to a globally unique object.

Reference provides a cryptographically secure way to uniquely identify objects based on their content. It is a fixed-size (32 bytes) identifier, typically derived from the SHA-256 hash of the object’s serialized form.

References are useful in distributed systems for:

• Unique identification of objects across networks
• Verification that an object hasn’t been modified
• Content-addressable storage systems
• Linking between objects in a content-addressed way

A Reference can be displayed in various formats, including hexadecimal, ByteWords (a human-readable partial hash as words), and Bytemoji (a human-readable partial hash based on emojis).

Implementations

impl Reference

pub const REFERENCE_SIZE: usize = 32usize

pub fn from_data(data: [u8; 32]) -> Self

Create a new reference from data.

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Self>

Create a new reference from data.

Returns None if the data is not the correct length.

pub fn from_digest(digest: Digest) -> Self

Create a new reference from the given digest.

pub fn data(&self) -> &[u8; 32]

Get the data of the reference.

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

Get the data of the reference as a byte slice.

pub fn from_hex(hex: impl AsRef<str>) -> Self

Create a new reference from the given hexadecimal string.

Panics

Panics if the string is not exactly 64 hexadecimal digits.

pub fn ref_hex(&self) -> String

The data as a hexadecimal string.

pub fn ref_data_short(&self) -> [u8; 4]

The first four bytes of the reference

pub fn ref_hex_short(&self) -> String

The first four bytes of the reference as a hexadecimal string.

pub fn bytewords_identifier(&self, prefix: Option<&str>) -> String

The first four bytes of the XID as upper-case ByteWords.

pub fn bytemoji_identifier(&self, prefix: Option<&str>) -> String

The first four bytes of the XID as Bytemoji.

Trait Implementations

impl AsRef<[u8]> for Reference

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

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

impl AsRef<Reference> for Reference

fn as_ref(&self) -> &Reference

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

impl CBORTagged for Reference

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for Reference

fn from_untagged_cbor(cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

fn from_tagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

fn from_untagged_cbor_data(data: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for Reference

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl DigestProvider for Reference

fn digest(&self) -> Cow<'_, Digest>

Returns a digest that uniquely characterizes the content of the implementing type.

impl Display for Reference

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

Formats the value using the given formatter.

impl<'a> From<&'a Reference> for &'a [u8]

fn from(value: &'a Reference) -> Self

Converts to this type from the input type.

impl<'a> From<&'a Reference> for &'a [u8; 32]

fn from(value: &'a Reference) -> Self

Converts to this type from the input type.

impl From<&Reference> for Reference

fn from(digest: &Reference) -> Self

Converts to this type from the input type.

impl From<&Reference> for Vec<u8>

fn from(digest: &Reference) -> Self

Converts to this type from the input type.

impl From<Reference> for CBOR

fn from(value: Reference) -> Self

Converts to this type from the input type.

impl From<Reference> for Vec<u8>

fn from(digest: Reference) -> Self

Converts to this type from the input type.

impl Hash for Reference

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 Ord for Reference

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 Reference

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

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 ReferenceProvider for Reference

Implement the ReferenceProvider trait for Reference.

Yes, this creates a Reference to a Reference.

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object.

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string.

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference.

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string.

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords.

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji.

impl TryFrom<CBOR> for Reference

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl Eq for Reference

impl StructuralPartialEq for Reference