Struct Word

Source
pub struct Word(/* private fields */);
Expand description

A unit of data consisting of 4 field elements.

Implementations§

Source§

impl Word

Source

pub const SERIALIZED_SIZE: usize = 32usize

The serialized size of the word in bytes.

Source

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

Creates a new Word from the given field elements.

Source

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

Returns the word as a slice of field elements.

Source

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

Returns the word as a byte array.

Source

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

Returns all elements of multiple words as a slice.

Source

pub fn to_hex(&self) -> String

Returns hexadecimal representation of this word prefixed with 0x.

Source

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

Returns internal elements of this word as a vector.

Trait Implementations§

Source§

impl Clone for Word

Source§

fn clone(&self) -> Word

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Word

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Word

Source§

fn default() -> Word

Returns the “default value” for a type. Read more
Source§

impl Deref for Word

Source§

type Target = [BaseElement; 4]

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl DerefMut for Word

Source§

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

Mutably dereferences the value.
Source§

impl Deserializable for Word

Source§

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. Read more
Source§

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

Attempts to deserialize the provided bytes into Self and returns the result. Read more
Source§

impl Digest for Word

Source§

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

Returns this digest serialized into an array of bytes. Read more
Source§

impl Display for Word

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<[BaseElement; 4]> for Word

Source§

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

Converts to this type from the input type.
Source§

impl From<[bool; 4]> for Word

Source§

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

Converts to this type from the input type.
Source§

impl From<[u16; 4]> for Word

Source§

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

Converts to this type from the input type.
Source§

impl From<[u32; 4]> for Word

Source§

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

Converts to this type from the input type.
Source§

impl From<[u8; 4]> for Word

Source§

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

Converts to this type from the input type.
Source§

impl<T> From<LexicographicWord<T>> for Word
where T: Into<Word>,

Source§

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

Converts to this type from the input type.
Source§

impl From<PublicKey> for Word

Source§

fn from(key: PublicKey) -> Word

Converts to this type from the input type.
Source§

impl From<Word> for [BaseElement; 4]

Source§

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

Converts to this type from the input type.
Source§

impl From<Word> for [u64; 4]

Source§

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

Converts to this type from the input type.
Source§

impl From<Word> for [u8; 32]

Source§

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

Converts to this type from the input type.
Source§

impl FromIterator<Word> for MerklePath

Source§

fn from_iter<T>(iter: T) -> MerklePath
where T: IntoIterator<Item = Word>,

Creates a value from an iterator. Read more
Source§

impl Hash for Word

Source§

fn hash<H>(&self, state: &mut H)
where H: Hasher,

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Index<Range<usize>> for Word

Source§

type Output = [BaseElement]

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl Index<usize> for Word

Source§

type Output = BaseElement

The returned type after indexing.
Source§

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

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<Range<usize>> for Word

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl IndexMut<usize> for Word

Source§

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

Performs the mutable indexing (container[index]) operation. Read more
Source§

impl IntoIterator for Word

Source§

type Item = BaseElement

The type of the elements being iterated over.
Source§

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

Which kind of iterator are we turning this into?
Source§

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

Creates an iterator from a value. Read more
Source§

impl KvMap<Word, Vec<BaseElement>> for AdviceMap

Source§

fn get(&self, key: &Word) -> Option<&Vec<BaseElement>>

Source§

fn contains_key(&self, key: &Word) -> bool

Source§

fn len(&self) -> usize

Source§

fn insert( &mut self, key: Word, value: Vec<BaseElement>, ) -> Option<Vec<BaseElement>>

Source§

fn remove(&mut self, key: &Word) -> Option<Vec<BaseElement>>

Source§

fn iter(&self) -> Box<dyn Iterator<Item = (&Word, &Vec<BaseElement>)> + '_>

Source§

fn is_empty(&self) -> bool

Source§

impl Ord for Word

Source§

fn cmp(&self, other: &Word) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Word

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Word

Source§

fn partial_cmp(&self, other: &Word) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Randomizable for Word

Source§

const VALUE_SIZE: usize = 32usize

Size of Self in bytes. Read more
Source§

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

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

impl Serializable for Word

Source§

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

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

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self. Read more
Source§

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

Serializes self into a vector of bytes.
Source§

impl TryFrom<&[BaseElement]> for Word

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<&[u8]> for Word

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<&String> for Word

Source§

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

Expects the string to start with 0x.

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<&str> for Word

Source§

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

Expects the string to start with 0x.

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

impl TryFrom<[u64; 4]> for Word

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<[u8; 32]> for Word

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<String> for Word

Source§

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

Expects the string to start with 0x.

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

impl TryFrom<Word> for [bool; 4]

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Word> for [u16; 4]

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Word> for [u32; 4]

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Word> for [u8; 4]

Source§

type Error = WordError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Copy for Word

Source§

impl Eq for Word

Source§

impl StructuralPartialEq for Word

Auto Trait Implementations§

§

impl Freeze for Word

§

impl RefUnwindSafe for Word

§

impl Send for Word

§

impl Sync for Word

§

impl Unpin for Word

§

impl UnwindSafe for Word

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more