Struct Digest 

pub struct Digest(/* private fields */);

Digest represents the results of a hashing function. It is always 256 bits of storage although depending on the hash it may have additional structure (for example Poseidon’s output is actually composed of field elements). The storage is in u32’s in part to simplify alignment requirements, especially in the zkVM.

Implementations

impl Digest

pub const ZERO: Digest

Digest of all zeroes.

pub const fn new(data: [u32; 8]) -> Digest

Constant constructor

pub const fn from_bytes(bytes: [u8; 32]) -> Digest

Construct a digest from a array of bytes in a const context. Outside of const context, Digest::from is recommended.

pub fn as_words(&self) -> &[u32]

Returns a reference to the Digest as a slice of words.

pub fn as_bytes(&self) -> &[u8]

Returns a reference to the Digest as a slice of bytes.

pub fn as_mut_words(&mut self) -> &mut [u32]

Returns a mutable slice of words.

pub fn as_mut_bytes(&mut self) -> &mut [u8]

Returns a mutable slice of bytes.

Trait Implementations

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 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<[u32; 8]> for Digest

fn as_mut(&mut self) -> &mut [u32; 8]

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

impl AsMut<[u32]> for Digest

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

Converts this type into a mutable 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 AsRef<[u8]> for Digest

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

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

impl AsRef<[u32; 8]> for Digest

fn as_ref(&self) -> &[u32; 8]

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

impl AsRef<[u32]> for Digest

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

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

impl BorshDeserialize for Digest

fn deserialize_reader<__R>(reader: &mut __R) -> Result<Digest, Error>

where __R: Read,

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

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Digest

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

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 Copy for Digest

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<'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 Eq for Digest

impl<'a> From<&'a [u32; 8]> for &'a Digest

fn from(data: &'a [u32; 8]) -> &'a Digest

Converts to this type from the input type.

impl From<[u8; 32]> for Digest

Create a new Digest from an array of bytes.

fn from(data: [u8; 32]) -> Digest

Converts to this type from the input type.

impl From<[u32; 8]> for Digest

Create a new Digest from an array of words.

fn from(data: [u32; 8]) -> Digest

Converts to this type from the input type.

impl FromHex for Digest

type Error = FromHexError

fn from_hex<T>(hex: T) -> Result<Digest, <Digest as FromHex>::Error>

where T: AsRef<[u8]>,

Creates an instance of type Self from the given hex string, or fails with a custom error 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 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Digest

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

Equality operator ==.

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

Inequality operator !=.

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 Pod for Digest

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 StructuralPartialEq for Digest

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

type Error = PodCastError

The type returned in the event of a conversion error.

fn try_from( data: &'a [u32], ) -> Result<&'a Digest, <&'a Digest as TryFrom<&'a [u32]>>::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(data: &[u8]) -> Result<Digest, <Digest as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl TryFrom<&[u32]> for Digest

type Error = TryFromSliceError

The type returned in the event of a conversion error.

fn try_from(data: &[u32]) -> Result<Digest, <Digest as TryFrom<&[u32]>>::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( data: Vec<u8>, ) -> Result<Digest, <Digest as TryFrom<Vec<u8>>>::Error>

Performs the conversion.

impl TryFrom<Vec<u32>> for Digest

type Error = Vec<u32>

The type returned in the event of a conversion error.

fn try_from( data: Vec<u32>, ) -> Result<Digest, <Digest as TryFrom<Vec<u32>>>::Error>

Performs the conversion.

impl Zeroable for Digest

fn zeroed() -> Self

Calls zeroed.