Struct WitnessValues

pub struct WitnessValues(/* private fields */);

Map of witness values.

Implementations

impl WitnessValues

pub fn analyze(from: &ModuleProgram) -> Result<Self, RichError>

impl WitnessValues

pub fn get(&self, name: &WitnessName) -> Option<&Value>

Get the value that is assigned to the given name.

pub fn iter(&self) -> impl Iterator<Item = (&WitnessName, &Value)>

Create an iterator over all name-value pairs.

pub fn shallow_clone(&self) -> Self

Make a cheap copy of the map.

impl WitnessValues

pub fn is_consistent(&self, witness_types: &WitnessTypes) -> Result<(), Error>

Check if the witness values are consistent with the declared witness types.

1. Values that occur in the program are type checked.
2. Values that don’t occur in the program are skipped. The witness map may contain more values than necessary.

There may be witnesses that are referenced in the program that are not assigned a value in the witness map. These witnesses may lie on pruned branches that will not be part of the finalized Simplicity program. However, before the finalization, we cannot know which witnesses will be pruned and which won’t be pruned. This check skips unassigned witnesses.

Trait Implementations

impl Clone for WitnessValues

fn clone(&self) -> WitnessValues

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WitnessValues

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

Formats the value using the given formatter.

impl Default for WitnessValues

fn default() -> WitnessValues

Returns the “default value” for a type.

impl Display for WitnessValues

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

Formats the value using the given formatter.

impl From<HashMap<WitnessName, Value>> for WitnessValues

fn from(value: HashMap<WitnessName, Value>) -> Self

Converts to this type from the input type.

impl ParseFromStr for WitnessValues

fn parse_from_str(s: &str) -> Result<Self, RichError>

Parse a value from the string s.

impl PartialEq for WitnessValues

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

impl StructuralPartialEq for WitnessValues