Struct Digest

pub struct Digest(pub [BFieldElement; 5]);

The result of hashing a sequence of elements, for example using Tip5. Sometimes called a “hash”.

Tuple Fields

0: [BFieldElement; 5]

Implementations

impl Digest

pub const LEN: usize = 5usize

The number of elements in a digest.

pub const BYTES: usize = 40usize

The number of bytes in a digest.

pub const fn values(self) -> [BFieldElement; 5]

pub const fn new(digest: [BFieldElement; 5]) -> Digest

pub const fn reversed(self) -> Digest

Returns a new digest but whose elements are reversed relative to self. This function is an involutive endomorphism.

impl Digest

pub fn hash(self) -> Digest

Hash this digest using Tip5, producing a new digest.

A digest can be used as a source of entropy. It can be beneficial or even necessary to not reveal the entropy itself, but use it as the seed for some deterministic computation. In such cases, hashing the digest using this method is probably the right thing to do. If the digest in question is used for its entropy only, there might not be a known meaningful pre-image for that digest.

This method invokes Tip5::hash_pair with the right operand being the zero digest, agreeing with the standard way to hash a digest in the virtual machine.

pub fn to_hex(self) -> String

Encode digest as hex.

Since Digest also implements LowerHex and UpperHex, it is possible to {:x}-format directly, e.g., print!("{digest:x}").

pub fn try_from_hex( data: impl AsRef<[u8]>, ) -> Result<Digest, TryFromHexDigestError>

Decode hex string to Digest. Must not include leading “0x”.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Digest

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Digest, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Digest, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl BFieldCodec for Digest

type Error = DigestBFieldDecodingError

fn decode( sequence: &[BFieldElement], ) -> Result<Box<Digest>, <Digest as BFieldCodec>::Error>

fn encode(&self) -> Vec<BFieldElement>

fn static_length() -> Option<usize>

Returns the length in number of BFieldElements if it is known at compile-time. Otherwise, None.

impl Clone for Digest

fn clone(&self) -> Digest

Returns a copy 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<'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 From<Digest> for [u8; 40]

fn from(_: Digest) -> [u8; 40]

Converts to this type from the input type.

impl From<Digest> for Vec<BFieldElement>

fn from(val: Digest) -> Vec<BFieldElement>

Converts to this type from the input type.

impl From<XFieldElement> for Digest

fn from(xfe: XFieldElement) -> Digest

Interpret the XFieldElement as a Digest. No hashing is performed. This interpretation can be useful for the AlgebraicHasher trait and, by extension, allows building MerkleTrees directly from XFieldElements.

impl FromStr for Digest

type Err = TryFromDigestError

The associated error which can be returned from parsing.

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

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

impl GetSize for Digest

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_size(&self) -> usize

Determines the total size of the object.

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 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 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 TryFrom<&[BFieldElement]> for Digest

type Error = TryFromDigestError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8]> for Digest

type Error = TryFromDigestError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 40]> for Digest

type Error = TryFromDigestError

The type returned in the event of a conversion error.

fn try_from( item: [u8; 40], ) -> Result<Digest, <Digest as TryFrom<[u8; 40]>>::Error>

Performs the conversion.

impl TryFrom<BigUint> for Digest

type Error = TryFromDigestError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Digest> for XFieldElement

type Error = TryFromXFieldElementError

The type returned in the event of a conversion error.

fn try_from( digest: Digest, ) -> Result<XFieldElement, <XFieldElement as TryFrom<Digest>>::Error>

Performs the conversion.

impl TryFrom<Vec<BFieldElement>> for Digest

type Error = TryFromDigestError

The type returned in the event of a conversion error.

fn try_from( value: Vec<BFieldElement>, ) -> Result<Digest, <Digest as TryFrom<Vec<BFieldElement>>>::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