Struct libp2p::multihash::MultihashGeneric

pub struct MultihashGeneric<S> where
    S: Size,  { /* private fields */ }

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::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<S> Multihash<S> where
    S: Size, 

pub fn wrap(code: u64, input_digest: &[u8]) -> Result<Multihash<S>, 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>(r: R) -> Result<Multihash<S>, Error> where
    R: Read,
    Multihash<S>: Sized, 

Reads a multihash from a byte stream.

pub fn from_bytes(bytes: &[u8]) -> Result<Multihash<S>, Error> where
    Multihash<S>: 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<W>(&self, w: W) -> Result<(), Error> where
    W: Write, 

Writes a multihash to a byte stream.

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

Returns the bytes of a multihash.

Trait Implementations

impl AsRef<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for PeerId

pub fn as_ref(
    &self
) -> &Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

Performs the conversion.

impl<S> Clone for Multihash<S> where
    S: Clone + Size, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Multihash<S> where
    S: Debug + Size, 

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

Formats the value using the given formatter.

impl<S> Default for Multihash<S> where
    S: Default + Size, 

pub fn default() -> Multihash<S>

Returns the “default value” for a type.

impl<S> From<Multihash<S>> for Vec<u8, Global> where
    S: Size, 

pub fn from(multihash: Multihash<S>) -> Vec<u8, Global>

Performs the conversion.

impl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key

pub fn from(
    m: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Key

Performs the conversion.

impl From<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

pub fn from(
    m: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Key<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>

Performs the conversion.

impl From<PeerId> for Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

pub fn from(
    peer_id: PeerId
) -> Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

Performs the conversion.

impl<S> Hash for Multihash<S> where
    S: Size, 

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

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<S> Ord for Multihash<S> where
    S: Ord + Size, 

pub 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<S> PartialEq<Multihash<S>> for Multihash<S> where
    S: PartialEq<S> + Size, 

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

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

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

This method tests for !=.

impl<S> PartialOrd<Multihash<S>> for Multihash<S> where
    S: PartialOrd<S> + Size, 

pub 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 TryFrom<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>> for PeerId

type Error = Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>

The type returned in the event of a conversion error.

pub fn try_from(
    value: Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>
) -> Result<PeerId, <PeerId as TryFrom<Multihash<UInt<UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>, B0>>>>::Error>

Performs the conversion.

impl<S> Copy for Multihash<S> where
    S: Size,
    <S as ArrayLength<u8>>::ArrayType: Copy, 

impl<S> Eq for Multihash<S> where
    S: Eq + Size, 

impl<S> StructuralEq for Multihash<S> where
    S: Size, 

impl<S> StructuralPartialEq for Multihash<S> where
    S: Size,