Struct DocumentId 

pub struct DocumentId { /* private fields */ }

A content-addressable document identifier.

Format: algorithm:hexdigest

Examples

use cdx_core::{DocumentId, HashAlgorithm};

let id = DocumentId::new(HashAlgorithm::Sha256, vec![0xab; 32]);
assert!(id.to_string().starts_with("sha256:"));

Implementations

impl DocumentId

pub fn new(algorithm: HashAlgorithm, digest: Vec<u8>) -> Self

Create a new document ID from algorithm and digest bytes.

pub const fn algorithm(&self) -> HashAlgorithm

Get the hash algorithm.

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

Get the digest bytes.

pub fn hex_digest(&self) -> String

Get the hex-encoded digest.

pub fn is_pending(&self) -> bool

Check if this is a pending (placeholder) ID.

pub fn pending() -> Self

Create a pending (placeholder) document ID.

Trait Implementations

impl Clone for DocumentId

fn clone(&self) -> DocumentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocumentId

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

Formats the value using the given formatter.

impl FromStr for DocumentId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for DocumentId

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 DocumentId

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocumentId

impl StructuralPartialEq for DocumentId