pub struct MultihashGeneric<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::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>
impl<const S: usize> Multihash<S>
pub const fn wrap(code: u64, input_digest: &[u8]) -> Result<Multihash<S>, Error>
pub const fn wrap(code: u64, input_digest: &[u8]) -> Result<Multihash<S>, Error>
Wraps the digest in a multihash.
pub fn digest(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn digest(&self) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
Returns the digest.
pub fn read<R>(r: R) -> Result<Multihash<S>, Error> where
R: Read,
Multihash<S>: Sized,
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,
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,
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>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
pub fn to_bytes(&self) -> Vec<u8, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Returns the bytes of a multihash.
pub fn truncate(&self, size: u8) -> Multihash<S>
pub fn truncate(&self, size: u8) -> Multihash<S>
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.
use multihash::{Code, MultihashDigest};
let hash = Code::Sha3_256.digest(b"Hello world!").truncate(20);
pub fn resize<const R: usize>(&self) -> Result<Multihash<R>, Error>
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.
use multihash::{Code, MultihashDigest, MultihashGeneric};
let hash = Code::Sha3_256.digest(b"Hello world!");
let large_hash: MultihashGeneric<32> = hash.resize().unwrap();
Trait Implementations
impl<'de, const S: usize> Deserialize<'de> for Multihash<S>
impl<'de, const S: usize> Deserialize<'de> for Multihash<S>
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Multihash<S>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
pub fn deserialize<__D>(
__deserializer: __D
) -> Result<Multihash<S>, <__D as Deserializer<'de>>::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
impl<const S: usize> Ord for Multihash<S>
impl<const S: usize> Ord for Multihash<S>
impl<const S: usize> PartialOrd<Multihash<S>> for Multihash<S>
impl<const S: usize> PartialOrd<Multihash<S>> for Multihash<S>
pub fn partial_cmp(&self, other: &Multihash<S>) -> Option<Ordering>
pub 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 · sourcefn lt(&self, other: &Rhs) -> bool
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 · sourcefn le(&self, other: &Rhs) -> bool
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
impl<const S: usize> Serialize for Multihash<S>
impl<const S: usize> Serialize for Multihash<S>
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
pub fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<const S: usize> Copy for Multihash<S>
impl<const S: usize> Eq for Multihash<S>
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more