Struct sp_multihash::MultihashGeneric

pub struct MultihashGeneric<const S: usize> { /* fields omitted */ }

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 sp_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::from_bytes(&digest_bytes).unwrap();
assert_eq!(mh.code(), Sha3_256);
assert_eq!(mh.size(), 32);
assert_eq!(mh.digest(), &digest_bytes[2..]);

Implementations

impl<const S: usize> Multihash<S>

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

Wraps the digest in a multihash.

pub fn code(&self) -> u64

Returns the code of the multihash.

pub fn size(&self) -> u8

Returns the size of the digest.

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

Returns the digest.

pub fn read(r: &mut ByteCursor) -> Result<Self, Error> where
    Self: Sized, 

Reads a multihash from a byte stream.

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.

pub fn write(&self, w: &mut ByteCursor) -> Result<(), Error>

Writes a multihash to a byte stream.

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

Returns the bytes of a multihash.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

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

Performs the conversion.

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

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

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

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

fn ne(&self, other: &Multihash<S>) -> bool

This method tests for !=.

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

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

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

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

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