Skip to main content

Multihash

Struct Multihash 

Source
pub struct Multihash(/* private fields */);
Expand description

A content hash tagged with its algorithm code.

Internally wraps multihash::Multihash<64> - 64 bytes of buffer, enough for any algorithm on mnem’s allow-list (SHA-256, BLAKE3-256 today; SHA-512, BLAKE3-512, etc. if later expanded).

§Equality

Two Multihash values are equal only if they have the same algorithm code AND the same digest bytes. A SHA-256 and a BLAKE3-256 of the same input never compare equal even if their digest bytes collide.

Implementations§

Source§

impl Multihash

Source

pub fn sha2_256(bytes: &[u8]) -> Self

Compute a SHA-256 multihash of bytes.

This is the default content-hash algorithm for mnem/0.1.

Source

pub fn blake3_256(bytes: &[u8]) -> Self

Compute a BLAKE3-256 multihash of bytes.

Produces a 32-byte digest with algorithm code 0x1e. Faster than SHA-256 in most conditions; accepted by mnem but not the default for mnem/0.1 .

Source

pub fn wrap(code: u64, digest: &[u8]) -> Result<Self, IdError>

Wrap a raw algorithm code + digest bytes into a Multihash.

§Errors

Returns IdError::Multihash if digest.len() > 64 or if the digest length is otherwise invalid for the declared code.

Source

pub const fn code(&self) -> u64

The algorithm code byte. See HASH_SHA2_256 and friends.

Source

pub const fn size(&self) -> u8

Digest length in bytes.

Source

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

Borrow the digest bytes.

Source

pub fn to_bytes(&self) -> Vec<u8>

Serialize to the multihash wire format: <code: varint> <size: varint> <digest>.

Source

pub fn from_bytes(bytes: &[u8]) -> Result<Self, IdError>

Parse a multihash from its wire format.

§Errors

Returns IdError::Multihash if the bytes are malformed.

Trait Implementations§

Source§

impl Clone for Multihash

Source§

fn clone(&self) -> Multihash

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Multihash

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Multihash

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<Multihash<64>> for Multihash

Source§

fn from(m: Multihash<64>) -> Self

Converts to this type from the input type.
Source§

impl Hash for Multihash

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Multihash

Source§

fn cmp(&self, other: &Multihash) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Multihash

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Multihash

Source§

fn partial_cmp(&self, other: &Multihash) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Multihash

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Multihash

Source§

impl StructuralPartialEq for Multihash

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,