Struct iprs::multihash::Multihash

pub struct Multihash { /* fields omitted */ }

Type adapts several hashing algorithms within multihash specification.

Implementations

impl Multihash

pub fn new(codec: Multicodec, data: &[u8]) -> Result<Multihash>

Create a Multihash instance, of type multi-codec for data. Digest will be created for data, using the multi-hash algorithm specified by codec.

pub fn from_digest(codec: Multicodec, digest: &[u8]) -> Result<Multihash>

New multihash from digest and multihash-type.

pub fn decode_lazy(data: &[u8]) -> Result<Multihash>

Create a lazy instance of multihash from data, where data contains encoded multihash. Call Self::parse method to de-serialize.

pub fn parse(&mut self) -> Result<()>

Lazy parse. Typically called after creating this instance using Self::decode_lazy constructor.

pub fn decode(buf: &[u8]) -> Result<(Multihash, &[u8])>

Decode a hash-digest that was encoded using multi-format specification.

• The type is an unsigned variable integer identifying the hash function. There is a default table, and it is configurable. The default table is the [multicodec table].
• The length is an unsigned variable integer counting the length of the digest, in bytes.
• The value is the hash function digest, with a length of exactly <digest-length> bytes.

Return the Multihash value and remaining byte-slice. Caller can use Self::to_codec, Self::to_digest, Self::unwrap methods to get the hash-digest and hash-algorithm used to generate the digest.

pub fn encode(&self) -> Result<Vec<u8>>

Encode hash-digest and associated headers as per multi-hash specification.

<hash-func-type><digest-length><digest-value>

impl Multihash

pub fn to_codec(&self) -> Result<Multicodec>

Return the multihash codec.

pub fn to_digest(&self) -> Result<Vec<u8>>

Return the underlying hash digest.

Panic if digest is not generated or decoded.

pub fn unwrap(self) -> Result<(Multicodec, Vec<u8>)>

Unwrap the underlying codec and hash digest. Panic if digest is not generated or decoded.

Trait Implementations

impl Clone for Multihash

fn clone(&self) -> Multihash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Multihash

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

Formats the value using the given formatter.

impl Eq for Multihash

impl From<Multihash> for PeerId

fn from(mh: Multihash) -> Self

Performs the conversion.

impl From<PeerId> for Multihash

fn from(peer_id: PeerId) -> Self

Performs the conversion.

impl PartialEq<Multihash> for Multihash

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

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

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

This method tests for !=.

impl StructuralEq for Multihash

impl StructuralPartialEq for Multihash

impl Write for Multihash

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Writeer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.