Struct multihash::Multihash

source ·
pub struct Multihash<const S: usize> { /* private fields */ }
Expand description

A Multihash instance that only supports the basic functionality and no hashing.

With this Multihash implementation you can operate on Multihashes in a generic way, but no hasher implementation is associated with the code.

Example

use multihash::Multihash;

const Sha3_256: u64 = 0x16;
let digest_bytes = [
    0x16, 0x20, 0x64, 0x4b, 0xcc, 0x7e, 0x56, 0x43, 0x73, 0x04, 0x09, 0x99, 0xaa, 0xc8, 0x9e,
    0x76, 0x22, 0xf3, 0xca, 0x71, 0xfb, 0xa1, 0xd9, 0x72, 0xfd, 0x94, 0xa3, 0x1c, 0x3b, 0xfb,
    0xf2, 0x4e, 0x39, 0x38,
];
let mh = Multihash::<32>::from_bytes(&digest_bytes).unwrap();
assert_eq!(mh.code(), Sha3_256);
assert_eq!(mh.size(), 32);
assert_eq!(mh.digest(), &digest_bytes[2..]);

Implementations§

source§

impl<const S: usize> Multihash<S>

source

pub const fn wrap(code: u64, input_digest: &[u8]) -> Result<Self, Error>

Wraps the digest in a multihash.

source

pub const fn code(&self) -> u64

Returns the code of the multihash.

source

pub const fn size(&self) -> u8

Returns the size of the digest.

source

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

Returns the digest.

source

pub fn read<R: Read>(r: R) -> Result<Self, Error>
where Self: Sized,

Reads a multihash from a byte stream.

source

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

Parses a multihash from a bytes.

You need to make sure the passed in bytes have the correct length. The digest length needs to match the size value of the multihash.

source

pub fn write<W: Write>(&self, w: W) -> Result<usize, Error>

Writes a multihash to a byte stream, returning the written size.

source

pub fn encoded_len(&self) -> usize

Returns the length in bytes needed to encode this multihash into bytes.

source

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

Returns the bytes of a multihash.

source

pub fn truncate(&self, size: u8) -> Self

Truncates the multihash to the given size. It’s up to the caller to ensure that the new size is secure (cryptographically) to use.

If the new size is larger than the current size, this method does nothing.

source

pub fn resize<const R: usize>(&self) -> Result<Multihash<R>, Error>

Resizes the backing multihash buffer.

This function fails if the hash digest is larger than the target size.

source

pub fn into_inner(self) -> (u64, [u8; S], u8)

Decomposes struct, useful when needing a Sized array or moving all the data into another type

It is recommended to use digest() code() and size() for most cases.

Trait Implementations§

source§

impl<const S: usize> Clone for Multihash<S>

source§

fn clone(&self) -> Multihash<S>

Returns a copy 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<const S: usize> Debug for Multihash<S>

source§

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

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

impl<const S: usize> Default for Multihash<S>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl<const S: usize> From<Multihash<S>> for Vec<u8>

source§

fn from(multihash: Multihash<S>) -> Self

Converts to this type from the input type.
source§

impl<const S: usize> Hash for Multihash<S>

source§

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

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<const S: usize> Ord for Multihash<S>

source§

fn cmp(&self, other: &Multihash<S>) -> 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 + PartialOrd,

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

impl<const A: usize, const B: usize> PartialEq<Multihash<B>> for Multihash<A>

source§

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

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

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.
source§

impl<const S: usize> PartialOrd for Multihash<S>

source§

fn partial_cmp(&self, other: &Multihash<S>) -> 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

This method 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

This method 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

This method 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

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

impl<const S: usize> Copy for Multihash<S>

source§

impl<const S: usize> Eq for Multihash<S>

source§

impl<const S: usize> StructuralEq for Multihash<S>

Auto Trait Implementations§

§

impl<const S: usize> RefUnwindSafe for Multihash<S>

§

impl<const S: usize> Send for Multihash<S>

§

impl<const S: usize> Sync for Multihash<S>

§

impl<const S: usize> Unpin for Multihash<S>

§

impl<const S: usize> UnwindSafe for Multihash<S>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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.