Struct Word 

#[repr(C)]
pub struct Word {
    pub a: Felt,
    pub b: Felt,
    pub c: Felt,
    pub d: Felt,
}

A unit of data consisting of 4 field elements.

For ordering a word with Ord the word’s elements are treated as limbs of an integer in little-endian limb order and thus comparison starts from the most significant element.

Fields

a: Felt

The underlying elements of this word.

b: Felt

c: Felt

d: Felt

Implementations

impl Word

pub const SERIALIZED_SIZE: usize = WORD_SIZE_BYTES

The serialized size of the word in bytes.

pub const fn new(value: [Felt; 4]) -> Word

Creates a new Word from the given field elements.

pub const fn into_elements(self) -> [Felt; 4]

Returns the elements of this word as an array.

pub const fn parse(hex: &str) -> Result<Word, &'static str>

Parses a hex string into a new Word.

The input must contain valid hex prefixed with 0x. The input after the prefix must contain between 0 and 64 characters (inclusive).

The input is interpreted to have little-endian byte ordering. Nibbles are interpreted to have big-endian ordering so that “0x10” represents Felt::new(16), not Felt::new(1).

This function is usually used via the word! macro.

use miden_field::{Felt, Word, word};
let word = word!("0x1000000000000000200000000000000030000000000000004000000000000000");
assert_eq!(word, Word::new([Felt::new(16), Felt::new(32), Felt::new(48), Felt::new(64)]));

pub const fn empty() -> Word

Returns a new Word consisting of four ZERO elements.

pub fn is_empty(&self) -> bool

Returns true if the word consists of four ZERO elements.

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

Returns the word as a slice of field elements.

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

Returns the word as a byte array.

pub fn words_as_elements_iter<'a, I>(words: I) -> impl Iterator<Item = &'a Felt>

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

Returns an iterator over the elements of multiple words.

pub fn words_as_elements(words: &[Word]) -> &[Felt]

Returns all elements of multiple words as a slice.

pub fn to_hex(&self) -> String

Returns hexadecimal representation of this word prefixed with 0x.

pub fn to_vec(&self) -> Vec<Felt>

Returns internal elements of this word as a vector.

pub fn reversed(&self) -> Word

Returns a copy of this word with its elements in reverse order.

Trait Implementations

impl Clone for Word

fn clone(&self) -> Word

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Word

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

Formats the value using the given formatter.

impl Default for Word

fn default() -> Word

Returns the “default value” for a type.

impl Deref for Word

type Target = [Felt; 4]

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Word

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

Mutably dereferences the value.

impl Deserializable for Word

Available on not (target_family=wasm and miden).

fn read_from<R>(source: &mut R) -> Result<Word, 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 min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

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

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

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

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for Word

fn deserialize<__D>( __deserializer: __D, ) -> Result<Word, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Word

Available on not (target_family=wasm and miden).

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

Formats the value using the given formatter.

impl From<&[Felt; 4]> for Word

fn from(value: &[Felt; 4]) -> Word

Converts to this type from the input type.

impl From<&[bool; 4]> for Word

fn from(value: &[bool; 4]) -> Word

Converts to this type from the input type.

impl From<&[u16; 4]> for Word

fn from(value: &[u16; 4]) -> Word

Converts to this type from the input type.

impl From<&[u32; 4]> for Word

fn from(value: &[u32; 4]) -> Word

Converts to this type from the input type.

impl From<&[u8; 4]> for Word

fn from(value: &[u8; 4]) -> Word

Converts to this type from the input type.

impl From<&Word> for [Felt; 4]

fn from(value: &Word) -> [Felt; 4]

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<[Felt; 4]> for Word

fn from(value: [Felt; 4]) -> Word

Converts to this type from the input type.

impl From<[bool; 4]> for Word

fn from(value: [bool; 4]) -> Word

Converts to this type from the input type.

impl From<[u16; 4]> for Word

fn from(value: [u16; 4]) -> Word

Converts to this type from the input type.

impl From<[u32; 4]> for Word

fn from(value: [u32; 4]) -> Word

Converts to this type from the input type.

impl From<[u8; 4]> for Word

fn from(value: [u8; 4]) -> Word

Converts to this type from the input type.

impl<T> From<LexicographicWord<T>> for Word

where T: Into<Word>,

fn from(key: LexicographicWord<T>) -> Word

Converts to this type from the input type.

impl From<Nonce> for Word

fn from(nonce: Nonce) -> Self

Converts to this type from the input type.

impl From<Word> for [Felt; 4]

fn from(value: Word) -> [Felt; 4]

Converts to this type from the input type.

impl From<Word> for [u64; 4]

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

Converts to this type from the input type.

impl From<Word> for [u8; 32]

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

Converts to this type from the input type.

impl From<Word> for LeafIndex<SMT_DEPTH>

fn from(value: Word) -> Self

Converts to this type from the input type.

impl From<Word> for LexicographicWord

fn from(word: Word) -> LexicographicWord

Converts to this type from the input type.

impl From<Word> for Nonce

fn from(word: Word) -> Self

Converts to this type from the input type.

impl FromIterator<Word> for MerklePath

fn from_iter<T: IntoIterator<Item = Word>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Word

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 Index<Range<usize>> for Word

type Output = [Felt]

The returned type after indexing.

fn index(&self, index: Range<usize>) -> &<Word as Index<Range<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for Word

type Output = Felt

The returned type after indexing.

fn index(&self, index: usize) -> &<Word as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<Range<usize>> for Word

fn index_mut( &mut self, index: Range<usize>, ) -> &mut <Word as Index<Range<usize>>>::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Word

fn index_mut(&mut self, index: usize) -> &mut <Word as Index<usize>>::Output

Performs the mutable indexing (container[index]) operation.

impl IntoIterator for Word

type Item = Felt

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl Ord for Word

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

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

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

const VALUE_SIZE: usize = WORD_SIZE_BYTES

Size of Self in bytes.

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

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

impl Serializable for Word

Available on not (target_family=wasm and miden).

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

where W: ByteWriter,

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

fn get_size_hint(&self) -> usize

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

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

Serializes self into a vector of bytes.

impl Serialize for Word

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<&[Felt]> for Word

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&[u8]> for Word

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&String> for Word

Available on not (target_family=wasm and miden).

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

Expects the string to start with 0x.

type Error = WordError

The type returned in the event of a conversion error.

impl TryFrom<&Word> for [bool; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from( value: &Word, ) -> Result<[bool; 4], <[bool; 4] as TryFrom<&Word>>::Error>

Performs the conversion.

impl TryFrom<&Word> for [u16; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from( value: &Word, ) -> Result<[u16; 4], <[u16; 4] as TryFrom<&Word>>::Error>

Performs the conversion.

impl TryFrom<&Word> for [u32; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from( value: &Word, ) -> Result<[u32; 4], <[u32; 4] as TryFrom<&Word>>::Error>

Performs the conversion.

impl TryFrom<&Word> for [u8; 4]

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&str> for Word

Available on not (target_family=wasm and miden).

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

Expects the string to start with 0x.

type Error = WordError

The type returned in the event of a conversion error.

impl TryFrom<[u64; 4]> for Word

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<[u8; 32]> for Word

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for Word

Available on not (target_family=wasm and miden).

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

Expects the string to start with 0x.

type Error = WordError

The type returned in the event of a conversion error.

impl TryFrom<Word> for [bool; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from( value: Word, ) -> Result<[bool; 4], <[bool; 4] as TryFrom<Word>>::Error>

Performs the conversion.

impl TryFrom<Word> for [u16; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from(value: Word) -> Result<[u16; 4], <[u16; 4] as TryFrom<Word>>::Error>

Performs the conversion.

impl TryFrom<Word> for [u32; 4]

type Error = WordError

The type returned in the event of a conversion error.

fn try_from(value: Word) -> Result<[u32; 4], <[u32; 4] as TryFrom<Word>>::Error>

Performs the conversion.

impl TryFrom<Word> for [u8; 4]

type Error = WordError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Word

impl Eq for Word

impl StructuralPartialEq for Word