Struct twenty_first::math::digest::Digest

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

Tuple Fields

0: [BFieldElement; 5]

Implementations

impl Digest

pub const BYTES: usize = 40usize

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

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

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<H: AlgebraicHasher>(self) -> Digest

Simulates the VM as it hashes a digest. This method invokes hash_pair with the right operand being the zero digest, agreeing with the standard way to hash a digest in the virtual machine.

Trait Implementations

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

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

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<Self>, Self::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

Formats the value using the given formatter.

impl Default for Digest

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Digest

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

Formats the value using the given formatter.

impl Distribution<Digest> for Standard

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Digest

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<[u8; 40]> for Digest

fn from(item: [u8; 40]) -> Self

Converts to this type from the input type.

impl From<Digest> for [u8; 40]

fn from(item: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for BigUint

fn from(digest: Digest) -> Self

Converts to this type from the input type.

impl From<Digest> for Vec<BFieldElement>

fn from(val: Digest) -> Self

Converts to this type from the input type.

impl From<XFieldElement> for Digest

fn from(xfe: XFieldElement) -> Self

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<Self, Self::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: Hasher>(&self, state: &mut __H)

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: &Self) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Digest

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

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

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

This method 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: &Self) -> Option<Ordering>

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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::Ok, __S::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<Self, Self::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<Self, Self::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<Self, Self::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<Self, Self::Error>

Performs the conversion.

impl Copy for Digest

impl Eq for Digest

impl StructuralPartialEq for Digest