Struct Multihash

pub struct Multihash<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 tiny_multihash::{Multihash, U64};

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::<U64>::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: Size> 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: Read>(r: R) -> 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<W: Write>(&self, w: W) -> 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<S: Clone + Size> 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<S: Debug + Size> Debug for Multihash<S>

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

Formats the value using the given formatter.

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

fn default() -> Multihash<S>

Returns the “default value” for a type.

impl<S: PartialEq + Size> PartialEq for Multihash<S>

fn eq(&self, other: &Multihash<S>) -> 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<S: Size> Copy for Multihash<S>

where <S as ArrayLength<u8>>::ArrayType: Copy,

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

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