Struct LexicographicWord 

pub struct LexicographicWord<T = Word>(/* private fields */)
where
    T: Into<Word>;

A Word wrapper with lexicographic ordering.

This is a wrapper around any Word convertible type that overrides the equality and ordering implementations with a lexigographic one based on the wrapped type’s Word representation.

Implementations

impl<T> LexicographicWord<T>

where T: Into<Word>,

pub fn new(inner: T) -> LexicographicWord<T>

Wraps the provided value into a new LexicographicWord.

pub fn inner(&self) -> &T

Returns a reference to the inner value.

pub fn into_inner(self) -> T

Consumes self and returns the inner value.

Trait Implementations

impl<T> Clone for LexicographicWord<T>

where T: Clone + Into<Word>,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for LexicographicWord<T>

where T: Debug + Into<Word>,

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

Formats the value using the given formatter.

impl<T> Deserializable for LexicographicWord<T>

where T: Into<Word> + From<Word>,

Available on not (target_family=wasm and miden).

fn read_from<R>( source: &mut R, ) -> Result<LexicographicWord<T>, 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 From<[Felt; 4]> for LexicographicWord

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

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<Word> for LexicographicWord

fn from(word: Word) -> LexicographicWord

Converts to this type from the input type.

impl<T> Ord for LexicographicWord<T>

where T: Into<Word> + Copy,

fn cmp(&self, other: &LexicographicWord<T>) -> 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<T> PartialEq for LexicographicWord<T>

where T: Into<Word> + Copy,

fn eq(&self, other: &LexicographicWord<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> PartialOrd for LexicographicWord<T>

where T: Into<Word> + Copy,

fn partial_cmp(&self, other: &LexicographicWord<T>) -> 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<T> Serializable for LexicographicWord<T>

where T: Into<Word> + Copy,

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<T> Copy for LexicographicWord<T>

where T: Copy + Into<Word>,

impl<T> Eq for LexicographicWord<T>

where T: Into<Word> + Copy,