Struct ARID 

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

An “Apparently Random Identifier” (ARID)

An ARID is a cryptographically strong, universally unique identifier with the following properties:

• Non-correlatability: The sequence of bits cannot be correlated with its referent or any other ARID
• Neutral semantics: Contains no inherent type information
• Open generation: Any method of generation is allowed as long as it produces statistically random bits
• Minimum strength: Must be 256 bits (32 bytes) in length
• Cryptographic suitability: Can be used as inputs to cryptographic constructs

Unlike digests/hashes which identify a fixed, immutable state of data, ARIDs can serve as stable identifiers for mutable data structures.

ARIDs should not be confused with or cast to/from other identifier types (like UUIDs), used as nonces, keys, or cryptographic seeds.

As defined in BCR-2022-002.

Implementations

impl ARID

pub const ARID_SIZE: usize = 32usize

pub fn new() -> Self

Create a new random ARID.

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

Restore a ARID from a fixed-size array of bytes.

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

Create a new ARID from a reference to an array of bytes.

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

Get the data of the ARID as an array of bytes.

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

Get the data of the ARID as a byte slice.

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

Create a new ARID from the given hexadecimal string.

Panics

Panics if the string is not exactly 64 hexadecimal digits.

pub fn hex(&self) -> String

The data as a hexadecimal string.

pub fn short_description(&self) -> String

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

Trait Implementations

impl AsRef<[u8]> for ARID

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

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

impl CBORTagged for ARID

Implements the CBORTagged trait to provide CBOR tag information.

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for ARID

Implements CBORTaggedDecodable to provide CBOR decoding functionality.

fn from_untagged_cbor(untagged_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 ARID

Implements CBORTaggedEncodable to provide CBOR encoding functionality.

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 ARID

fn clone(&self) -> ARID

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ARID

Implements Debug formatting for ARID showing the full hex representation.

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

Formats the value using the given formatter.

impl Default for ARID

Implements the Default trait to create a new random ARID.

fn default() -> Self

Returns the “default value” for a type.

impl Display for ARID

Implements Display formatting for ARID showing the hex representation.

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

Formats the value using the given formatter.

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

Implements conversion from an ARID reference to a byte slice reference.

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

Converts to this type from the input type.

impl From<ARID> for CBOR

Implements conversion from ARID to CBOR for serialization.

fn from(value: ARID) -> Self

Converts to this type from the input type.

impl Hash for ARID

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

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

Implements PartialOrd to allow ARIDs to be compared and ordered.

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 TryFrom<CBOR> for ARID

Implements TryFrom<CBOR> for ARID to support conversion from CBOR data.

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for ARID

impl Eq for ARID

impl StructuralPartialEq for ARID