Struct EvalAwi

pub struct EvalAwi { /* private fields */ }

When created from a type implementing AsRef<dag::Bits>, it can later be used to evaluate its dynamic value.

This will keep the source tree alive in case of pruning.

Custom Drop

Upon being dropped, this will remove special references being kept by the current Epoch.

Implementations

impl EvalAwi

pub fn from_bool(x: bool) -> Self

pub fn from_u8(x: u8) -> Self

pub fn from_i8(x: i8) -> Self

pub fn from_u16(x: u16) -> Self

pub fn from_i16(x: i16) -> Self

pub fn from_u32(x: u32) -> Self

pub fn from_i32(x: i32) -> Self

pub fn from_u64(x: u64) -> Self

pub fn from_i64(x: i64) -> Self

pub fn from_u128(x: u128) -> Self

pub fn from_i128(x: i128) -> Self

pub fn from_usize(x: usize) -> Self

pub fn from_isize(x: isize) -> Self

pub fn eval_bool(&self) -> Result<bool, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_u8(&self) -> Result<u8, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_i8(&self) -> Result<i8, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_u16(&self) -> Result<u16, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_i16(&self) -> Result<i16, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_u32(&self) -> Result<u32, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_i32(&self) -> Result<i32, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_u64(&self) -> Result<u64, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_i64(&self) -> Result<i64, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_u128(&self) -> Result<u128, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_i128(&self) -> Result<i128, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_usize(&self) -> Result<usize, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn eval_isize(&self) -> Result<isize, Error>

The same as EvalAwi::eval, except that it returns a primitive and returns an error if the bitwidth of the evaluation does not match the bitwidth of the primitive

pub fn from_state(p_state: PState) -> Self

Used internally to create EvalAwis

Panics

If an Epoch does not exist or the PState was pruned

pub fn p_external(&self) -> PExternal

pub fn nzbw(&self) -> NonZeroUsize

pub fn bw(&self) -> usize

pub fn try_clone(&self) -> Result<Self, Error>

Clones self, returning a perfectly equivalent Eval that will have the same eval effects. Returns an error if the active Epoch is not correct.

pub fn from_bits(bits: &Bits) -> Self

Can panic if the state has been pruned

pub fn eval(&self) -> Result<Awi, Error>

Evaluates the value that self would evaluate to given the current state of any LazyAwis. Depending on the conditions of internal LUTs, it may be possible to evaluate to a known value even if some inputs are opaque, but in general this will return an error that a bit could not be evaluated to a known value, if any upstream inputs are opaque.

pub fn eval_is_all_unknown(&self) -> Result<bool, Error>

Like EvalAwi::eval, except it returns if the values are all unknowns

pub fn set_debug_name<S: AsRef<str>>(&self, debug_name: S) -> Result<(), Error>

Sets a debug name for self that is used in debug reporting and rendering

pub fn opaque(w: NonZeroUsize) -> Self

pub fn zero(w: NonZeroUsize) -> Self

pub fn umax(w: NonZeroUsize) -> Self

pub fn imax(w: NonZeroUsize) -> Self

pub fn imin(w: NonZeroUsize) -> Self

pub fn uone(w: NonZeroUsize) -> Self

Trait Implementations

impl Binary for EvalAwi

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

Formats the value using the given formatter.

impl<const W: usize> Borrow<EvalAwi> for Out<W>

fn borrow(&self) -> &EvalAwi

Immutably borrows from an owned value.

impl Debug for EvalAwi

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

Can only display some fields if the Epoch self was created in is active

impl Display for EvalAwi

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

Formats the value using the given formatter.

impl Drop for EvalAwi

fn drop(&mut self)

Executes the destructor for this type.

impl<B: AsRef<Bits>> From<B> for EvalAwi

fn from(b: B) -> Self

Converts to this type from the input type.

impl<const W: usize> Into<EvalAwi> for Out<W>

fn into(self) -> EvalAwi

Converts this type into the (usually inferred) input type.

impl LowerHex for EvalAwi

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

Formats the value using the given formatter.

impl Octal for EvalAwi

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

Formats the value using the given formatter.

impl UpperHex for EvalAwi

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

Formats the value using the given formatter.