Struct Word

pub struct Word { /* private fields */ }

A Simplicity word. A value of type TWO^(2^n) for some 0 ≤ n < 32.

Implementations

impl Word

pub fn product(self, right: Self) -> Option<Self>

Concatenate two words into a larger word.

Both words have to have the same length, which is 2^n bits. The resulting word will be 2^(n + 1) bits long.

Returns None if the words differ in length.

Returns None if the words are already 2^31 bits long (the resulting word would be longer than 2^31 bits, which is not supported).

pub fn u1(bit: u8) -> Self

Create a 1-bit word.

Panics

The value is ouf of range.

pub fn u2(bit: u8) -> Self

Create a 2-bit word.

Panics

The value is ouf of range.

pub fn u4(bit: u8) -> Self

Create a 4-bit word.

Panics

The value is ouf of range.

pub fn u8(bit: u8) -> Self

Create an 8-bit word.

pub fn u16(bit: u16) -> Self

Create a 16-bit word.

pub fn u32(bit: u32) -> Self

Create a 32-bit word.

pub fn u64(bit: u64) -> Self

Create a 64-bit word.

pub fn u128(bit: u128) -> Self

Create a 128-bit word.

pub fn u256(bit: [u8; 32]) -> Self

Create a 256-bit word.

pub fn u512(bit: [u8; 64]) -> Self

Create a 512-bit word.

pub fn shallow_clone(&self) -> Self

Make a cheap copy of the word.

pub fn as_value(&self) -> &Value

Access the value of the word.

pub fn n(&self) -> u32

The word is of type TWO^(2^n). Return n.

pub fn len(&self) -> usize

Return the bit length of the word.

The word is of type TWO^(2^n). Return 2^n.

pub fn iter(&self) -> impl Iterator<Item = bool> + '_

Return an iterator over the bit encoding of the word.

Words have no padding, so their compact encoding is the same as the padded encoding. The universal encoding can be used in all situations.

pub fn from_bits<I: Iterator<Item = u8>>( bits: &mut BitIter<I>, n: u32, ) -> Result<Self, EarlyEndOfStreamError>

Decode a word of type TWO^(2^n) from bits.

Panics

n is greater than 31.

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

Formats the value using the given formatter.

impl Display for Word

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

Formats the value using the given formatter.

impl Hash for Word

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

impl StructuralPartialEq for Word