Struct ObjectId 

pub struct ObjectId { /* private fields */ }

A content-addressed object identifier (blake3:<hex>).

Implementations

impl ObjectId

pub fn from_hash(hash: &Hash) -> ObjectId

Build an id from the bytes of a BLAKE3 hash.

pub fn hash_bytes(bytes: &[u8]) -> ObjectId

Hash arbitrary bytes and return the resulting id.

pub fn hash_reader<R>(reader: R) -> Result<ObjectId, Error>

where R: Read,

Hash a stream incrementally (constant memory), e.g. a large file.

pub fn hex(&self) -> &str

The lowercase hex digest, without the algorithm prefix.

pub fn canonical(&self) -> String

The canonical blake3:<hex> string.

pub fn short(&self) -> &str

A short, human-friendly prefix of the hex digest (default 8 chars).

pub fn shard1(&self) -> &str

First two hex chars — used as the first storage shard directory.

pub fn shard2(&self) -> &str

Next two hex chars — used as the second storage shard directory.

Trait Implementations

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectId

fn deserialize<D>( deserializer: D, ) -> Result<ObjectId, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl FromStr for ObjectId

type Err = ObjectIdParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<ObjectId, <ObjectId as FromStr>::Err>

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

impl Hash for ObjectId

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 ObjectId

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

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId