Struct XID

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

A XID (eXtensible IDentifier).

Implementations

impl XID

pub const XID_SIZE: usize = 32usize

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

Create a new XID from data.

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

Create a new XID from data.

Returns None if the data is not the correct length.

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

Return the data of the XID.

pub fn new(genesis_key: &SigningPublicKey) -> Self

Create a new XID from the given public key (the “genesis key”).

The XID is the SHA-256 digest of the CBOR encoding of the public key.

pub fn validate(&self, key: &SigningPublicKey) -> bool

Validate the XID against the given public key.

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

Create a new XID from the given hexadecimal string.

Panics

Panics if the string is not exactly 64 hexadecimal digits.

pub fn to_hex(&self) -> String

The data as a hexadecimal string.

pub fn short_description(&self) -> String

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

pub fn bytewords_identifier(&self, prefix: bool) -> String

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

pub fn bytemoji_identifier(&self, prefix: bool) -> String

The first four bytes of the XID as Bytemoji.

pub fn lifehash_fingerprint(&self) -> Digest

The entire CBOR of the XID, run through SHA-256.

Trait Implementations

impl AsRef<[u8]> for XID

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

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

impl AsRef<XID> for XID

fn as_ref(&self) -> &XID

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

impl CBORTagged for XID

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for XID

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 XID

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 XID

fn clone(&self) -> XID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for XID

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

Formats the value using the given formatter.

impl Display for XID

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

Formats the value using the given formatter.

impl From<&PrivateKeyBase> for XID

fn from(key: &PrivateKeyBase) -> Self

Converts to this type from the input type.

impl From<&PublicKeyBase> for XID

fn from(key: &PublicKeyBase) -> Self

Converts to this type from the input type.

impl From<&SigningPrivateKey> for XID

fn from(key: &SigningPrivateKey) -> Self

Converts to this type from the input type.

impl From<&SigningPublicKey> for XID

fn from(key: &SigningPublicKey) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<&XID> for Vec<u8>

fn from(xid: &XID) -> Self

Converts to this type from the input type.

impl From<&XID> for XID

fn from(xid: &XID) -> Self

Converts to this type from the input type.

impl From<XID> for CBOR

fn from(value: XID) -> Self

Converts to this type from the input type.

impl From<XID> for Vec<u8>

fn from(xid: XID) -> Self

Converts to this type from the input type.

impl Hash for XID

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 XID

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 XID

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

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 XID

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for XID

impl StructuralPartialEq for XID