Struct Digest

#[repr(transparent)]
pub struct Digest(pub [u8; 32]);

A 32-byte digest.

Tuple Fields

0: [u8; 32]

Implementations

impl Digest

pub fn from_slice(slice: &[u8]) -> Digest

Creates a digest from a slice.

Panics

This method panics if the length of the slice is not 32 bytes.

Examples

Basic usage:

let buffer = (0..255).collect::<Vec<_>>();
assert_eq!(
    Digest::from_slice(&buffer[0..32]),
    digest!("0x000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f"),
);

pub fn from_ref(array: &[u8; 32]) -> &Digest

Creates a reference to a digest from a reference to a 32-byte array.

Examples

Basic usage:

let arrays = [[0; 32], [1; 32]];
for digest in arrays.iter().map(Digest::from_ref) {
    println!("{digest}");
}

pub fn from_mut(array: &mut [u8; 32]) -> &mut Digest

Creates a mutable reference to a digest from a mutable reference to a 32-byte array.

pub fn of(data: impl AsRef<[u8]>) -> Digest

Creates a digest by hashing some input.

Examples

Basic usage:

assert_eq!(
    Digest::of("Hello Ethereum!"),
    digest!("0x67e083fb08738b8d7984e349687fec5bf03224c2dad4906020dfab9a0e4ceeac"),
);

Trait Implementations

impl AsMut<[u8]> for Digest

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<[u8; 32]> for Digest

fn as_mut(&mut self) -> &mut [u8; 32]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for Digest

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for Digest

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Digest

fn clone(&self) -> Digest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Digest

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

Formats the value using the given formatter.

impl Default for Digest

fn default() -> Digest

Returns the “default value” for a type.

impl Deref for Digest

type Target = [u8; 32]

The resulting type after dereferencing.

fn deref(&self) -> &<Digest as Deref>::Target

Dereferences the value.

impl DerefMut for Digest

fn deref_mut(&mut self) -> &mut <Digest as Deref>::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Digest

fn deserialize<D>( deserializer: D, ) -> Result<Digest, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Digest

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

Formats the value using the given formatter.

impl FromStr for Digest

type Err = ParseDigestError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Digest, <Digest as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Digest

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a Digest

type Item = &'a u8

The type of the elements being iterated over.

type IntoIter = Iter<'a, u8>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a Digest as IntoIterator>::IntoIter

Creates an iterator from a value.

impl IntoIterator for Digest

type Item = u8

The type of the elements being iterated over.

type IntoIter = IntoIter<u8, 32>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Digest as IntoIterator>::IntoIter

Creates an iterator from a value.

impl LowerHex for Digest

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

Formats the value using the given formatter.

impl Ord for Digest

fn cmp(&self, other: &Digest) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&[u8]> for Digest

fn eq(&self, other: &&[u8]) -> 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 PartialEq<&mut [u8]> for Digest

fn eq(&self, other: &&mut [u8]) -> 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 PartialEq<[u8]> for Digest

fn eq(&self, other: &[u8]) -> 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 PartialEq<[u8; 32]> for Digest

fn eq(&self, other: &[u8; 32]) -> 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 PartialEq<Vec<u8>> for Digest

fn eq(&self, other: &Vec<u8>) -> 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 PartialEq for Digest

fn eq(&self, other: &Digest) -> 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 PartialOrd for Digest

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Digest

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.

impl<'a> TryFrom<&'a [u8]> for &'a Digest

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( value: &'a [u8], ) -> Result<&'a Digest, <&'a Digest as TryFrom<&'a [u8]>>::Error>

Performs the conversion.

impl TryFrom<&[u8]> for Digest

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Digest, <Digest as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut [u8]> for &'a mut Digest

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( value: &'a mut [u8], ) -> Result<&'a mut Digest, <&'a mut Digest as TryFrom<&'a mut [u8]>>::Error>

Performs the conversion.

impl TryFrom<&mut [u8]> for Digest

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from( value: &mut [u8], ) -> Result<Digest, <Digest as TryFrom<&mut [u8]>>::Error>

Performs the conversion.

impl TryFrom<Vec<u8>> for Digest

type Error = Vec<u8>

The type returned in the event of a conversion error.

fn try_from( value: Vec<u8>, ) -> Result<Digest, <Digest as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl UpperHex for Digest

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

Formats the value using the given formatter.

impl Copy for Digest

impl Eq for Digest

impl StructuralPartialEq for Digest