Struct Value

pub struct Value { /* private fields */ }

A Simplicity value.

Implementations

impl Value

pub fn shallow_clone(&self) -> Self

Make a cheap copy of the value.

pub fn ty(&self) -> &Final

Access the type of the value.

pub fn unit() -> Self

Create the unit value.

pub fn left(inner: Self, right: Arc<Final>) -> Self

Create a left value that wraps the given inner value.

pub fn right(left: Arc<Final>, inner: Self) -> Self

Create a right value that wraps the given inner value.

pub fn product(left: Self, right: Self) -> Self

Create a product value that wraps the given left and right values.

pub fn none(right: Arc<Final>) -> Self

Create a none value.

pub fn some(inner: Self) -> Self

Create a some value.

pub fn compact_len(&self) -> usize

Return the bit length of the value in compact encoding.

pub fn padded_len(&self) -> usize

Return the bit length of the value in padded encoding.

pub fn is_empty(&self) -> bool

Check if the value is a nested product of units. In this case, the value contains no information.

pub fn is_unit(&self) -> bool

Check if the value is a unit.

pub fn as_left(&self) -> Option<&Self>

Access the inner value of a left sum value.

pub fn as_right(&self) -> Option<&Self>

Access the inner value of a right sum value.

pub fn as_product(&self) -> Option<(&Self, &Self)>

Access the inner values of a product value.

pub fn u1(value: u8) -> Self

Create a 1-bit integer.

Panics

The value is out of range.

pub fn u2(value: u8) -> Self

Create a 2-bit integer.

Panics

The value is out of range.

pub fn u4(value: u8) -> Self

Create a 4-bit integer.

Panics

The value is ouf of range.

pub fn u8(value: u8) -> Self

Create an 8-bit integer.

pub fn u16(bytes: u16) -> Self

Create a 16-bit integer.

pub fn u32(bytes: u32) -> Self

Create a 32-bit integer.

pub fn u64(bytes: u64) -> Self

Create a 64-bit integer.

pub fn u128(bytes: u128) -> Self

Create a 128-bit integer.

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

Create a 256-bit integer.

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

Create a 512-bit integer.

pub fn from_byte_array<const N: usize>(bytes: [u8; N]) -> Self

Create a value from a byte array.

Panics

The array length is not a power of two.

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

Return an iterator over the compact bit encoding of the value.

This encoding is used for writing witness data and for computing IMRs.

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

Return an iterator over the padded bit encoding of the value.

This encoding is used to represent the value in the Bit Machine.

pub fn is_of_type(&self, ty: &Final) -> bool

Check if the value is of the given type.

impl Value

pub fn from_compact_bits<I: Iterator<Item = bool>>( bits: &mut I, ty: &Final, ) -> Result<Self, EarlyEndOfStreamError>

Decode a value of the given type from its compact bit encoding.

pub fn from_padded_bits<I: Iterator<Item = bool>>( bits: &mut I, ty: &Final, ) -> Result<Self, EarlyEndOfStreamError>

Decode a value of the given type from its padded bit encoding.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> DagLike for &'a Value

type Node = Value

The type of the DAG node, with no references or wrappers

fn data(&self) -> &Value

A pointer to the underlying data

fn as_dag_node(&self) -> Dag<Self>

Interpret the node as a DAG node

fn left_child(&self) -> Option<Self>

Accessor for the left child of the node, if one exists

fn right_child(&self) -> Option<Self>

Accessor for the right child of the node, if one exists

fn n_children(&self) -> usize

Number of children that the node has.

fn rtl_post_order_iter<S: SharingTracker<SwapChildren<Self>> + Default>( self, ) -> RtlPostOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in right-to-left post order.

fn pre_order_iter<S: SharingTracker<Self> + Default>( self, ) -> PreOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in pre-order.

fn verbose_pre_order_iter<S: SharingTracker<Self> + Default>( self, max_depth: Option<usize>, ) -> VerbosePreOrderIter<Self, S>

where Self: Clone,

Obtains a verbose iterator of all the nodes rooted at the DAG, in pre-order.

fn post_order_iter<S: SharingTracker<Self> + Default>( self, ) -> PostOrderIter<Self, S>

Obtains an iterator of all the nodes rooted at the DAG, in post order.

fn is_shared_as<S: SharingTracker<Self> + Default>(self) -> bool

where Self: Clone,

Checks whether a DAG’s internal sharing (as expressed by shared pointers) matches the given target sharing.

fn post_order_iter_with_tracker<S: SharingTracker<Self>>( self, tracker: S, ) -> PostOrderIter<Self, S>

Obtains an post-order iterator of all the nodes rooted at DAG, using the given tracker.

impl Debug for Value

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

Formats the value using the given formatter.

impl Display for Value

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

Formats the value using the given formatter.

impl Hash for Value

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 Value

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

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

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

impl StructuralPartialEq for Value