Struct Word

#[repr(C)]
pub struct Word<T>(pub [T; 4]);

An array of four bytes to represent a 32-bit value.

We use the generic type T to represent the different representations of a byte, ranging from a u8 to a AB::Var or AB::Expr.

Tuple Fields

0: [T; 4]

Implementations

impl<T> Word<T>

pub fn map<F, S>(self, f: F) -> Word<S>

where F: FnMut(T) -> S,

Applies f to each element of the word.

pub fn extend_var<AB: SP1AirBuilder<Var = T>>(var: T) -> Word<AB::Expr>

Extends a variable to a word.

impl<T: AbstractField> Word<T>

pub fn extend_expr<AB: SP1AirBuilder<Expr = T>>(expr: T) -> Word<AB::Expr>

Extends a variable to a word.

pub fn zero<AB: SP1AirBuilder<Expr = T>>() -> Word<T>

Returns a word with all zero expressions.

impl<F: Field> Word<F>

pub fn to_u32(&self) -> u32

Converts a word to a u32.

impl<V: Copy> Word<V>

pub fn reduce<AB: AirBuilder<Var = V>>(&self) -> AB::Expr

Reduces a word to a single variable.

Trait Implementations

impl<T> Borrow<Word<T>> for [T]

fn borrow(&self) -> &Word<T>

Immutably borrows from an owned value.

impl<T> BorrowMut<Word<T>> for [T]

fn borrow_mut(&mut self) -> &mut Word<T>

Mutably borrows from an owned value.

impl<T: Clone> Clone for Word<T>

fn clone(&self) -> Word<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Word<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Word<T>

fn default() -> Word<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: AbstractField> From<u32> for Word<F>

fn from(value: u32) -> Self

Converts to this type from the input type.

impl<T: Clone> FromIterator<T> for Word<T>

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

Creates a value from an iterator.

impl<T: Hash> Hash for Word<T>

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

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Word<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

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

impl<T> IntoIterator for Word<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T, WORD_SIZE>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for Word<T>

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

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Copy> Copy for Word<T>

impl<T: Eq> Eq for Word<T>

impl<T> StructuralPartialEq for Word<T>