Struct bc_components::CID

pub struct CID(_);

A “Common Identifier” (CID)

As defined in BCR-2022-002.

Implementations

impl CID

pub const CID_SIZE: usize = 32usize

pub fn new() -> Self

Create a new random CID.

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

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

pub fn from_data_ref<T>(data: &T) -> Option<Self>where T: AsRef<[u8]>,

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

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

Get the data of the CID.

pub fn from_hex<T>(hex: T) -> Selfwhere T: AsRef<str>,

Create a new CID 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 CID as a hexadecimal string.

Trait Implementations

impl AsRef<CID> for CID

fn as_ref(&self) -> &Self

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

impl CBORDecodable for CID

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

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for CID

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8, Global>

Returns the value in CBOR binary representation.

impl CBORTagged for CID

const CBOR_TAG: Tag = tags::CID

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for CID

fn from_untagged_cbor(untagged_cbor: &CBOR) -> Result<Self, Error>

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: &[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: &[u8]) -> Result<Self, Error>where Self: Sized,

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

impl CBORTaggedEncodable for CID

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.

impl Clone for CID

fn clone(&self) -> CID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CID

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

Formats the value using the given formatter.

impl Default for CID

fn default() -> Self

Returns the “default value” for a type.

impl Display for CID

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl Hash for CID

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<CID> for CID

fn eq(&self, other: &CID) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<CID> for CID

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CID

impl StructuralEq for CID

impl StructuralPartialEq for CID