Struct miden_processor::Digest

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

Implementations

impl RpoDigest

pub const fn new(value: [BaseElement; 4]) -> RpoDigest

pub fn as_elements(&self) -> &[BaseElement]

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

pub fn digests_as_elements<'a, I>( digests: I ) -> impl Iterator<Item = &'a BaseElement>

where I: Iterator<Item = &'a RpoDigest>,

pub fn to_hex(&self) -> String

Returns hexadecimal representation of this digest prefixed with 0x.

Methods from Deref<Target = [BaseElement; 4]>

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

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

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

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

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

Panics

Panics if M > N.

Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

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

Converts this array of bytes into a array of ASCII characters, or returns None if any of the characters is non-ASCII.

Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

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

Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.

Safety

Every byte in the array must be in 0..=127, or else this is UB.

Trait Implementations

impl Clone for RpoDigest

fn clone(&self) -> RpoDigest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RpoDigest

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

Formats the value using the given formatter.

impl Default for RpoDigest

fn default() -> RpoDigest

Returns the “default value” for a type.

impl Deref for RpoDigest

type Target = [BaseElement; 4]

The resulting type after dereferencing.

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

Dereferences the value.

impl Deserializable for RpoDigest

fn read_from<R>(source: &mut R) -> Result<RpoDigest, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Digest for RpoDigest

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

Returns this digest serialized into an array of bytes.

impl Display for RpoDigest

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

Formats the value using the given formatter.

impl From<&[BaseElement; 4]> for RpoDigest

fn from(value: &[BaseElement; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<&RpoDigest> for [BaseElement; 4]

fn from(value: &RpoDigest) -> [BaseElement; 4]

Converts to this type from the input type.

impl From<&RpoDigest> for [u64; 4]

fn from(value: &RpoDigest) -> [u64; 4]

Converts to this type from the input type.

impl From<&RpoDigest> for [u8; 32]

fn from(value: &RpoDigest) -> [u8; 32]

Converts to this type from the input type.

impl From<[BaseElement; 4]> for RpoDigest

fn from(value: [BaseElement; 4]) -> RpoDigest

Converts to this type from the input type.

impl From<RpoDigest> for [BaseElement; 4]

fn from(value: RpoDigest) -> [BaseElement; 4]

Converts to this type from the input type.

impl From<RpoDigest> for [u64; 4]

fn from(value: RpoDigest) -> [u64; 4]

Converts to this type from the input type.

impl From<RpoDigest> for [u8; 32]

fn from(value: RpoDigest) -> [u8; 32]

Converts to this type from the input type.

impl FromIterator<RpoDigest> for MerklePath

fn from_iter<T>(iter: T) -> MerklePath

where T: IntoIterator<Item = RpoDigest>,

Creates a value from an iterator.

impl IntoIterator for RpoDigest

type Item = BaseElement

The type of the elements being iterated over.

type IntoIter = <[BaseElement; 4] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl Ord for RpoDigest

fn cmp(&self, other: &RpoDigest) -> 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 RpoDigest

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

fn partial_cmp(&self, other: &RpoDigest) -> 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 Randomizable for RpoDigest

const VALUE_SIZE: usize = 32usize

Size of Self in bytes.

fn from_random_bytes(bytes: &[u8]) -> Option<RpoDigest>

Returns Self if the set of bytes forms a valid value, otherwise returns None.

impl Serializable for RpoDigest

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl TryFrom<&[u64; 4]> for RpoDigest

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from(value: &[u64; 4]) -> Result<RpoDigest, RpoDigestError>

Performs the conversion.

impl TryFrom<&[u8]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8; 32]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&String> for RpoDigest

fn try_from( value: &String ) -> Result<RpoDigest, <RpoDigest as TryFrom<&String>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl TryFrom<&str> for RpoDigest

fn try_from( value: &str ) -> Result<RpoDigest, <RpoDigest as TryFrom<&str>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl TryFrom<[u64; 4]> for RpoDigest

type Error = RpoDigestError

The type returned in the event of a conversion error.

fn try_from(value: [u64; 4]) -> Result<RpoDigest, RpoDigestError>

Performs the conversion.

impl TryFrom<[u8; 32]> for RpoDigest

type Error = HexParseError

The type returned in the event of a conversion error.

fn try_from( value: [u8; 32] ) -> Result<RpoDigest, <RpoDigest as TryFrom<[u8; 32]>>::Error>

Performs the conversion.

impl TryFrom<String> for RpoDigest

fn try_from( value: String ) -> Result<RpoDigest, <RpoDigest as TryFrom<String>>::Error>

Expects the string to start with 0x.

type Error = HexParseError

The type returned in the event of a conversion error.

impl Copy for RpoDigest

impl Eq for RpoDigest

impl StructuralPartialEq for RpoDigest