Struct AdviceMap 

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

Defines a set of non-deterministic (advice) inputs which the VM can access by their keys.

Each key maps to one or more field element. To access the elements, the VM can move the values associated with a given key onto the advice stack using adv.push_mapval instruction. The VM can also insert new values into the advice map during execution.

Implementations

impl AdviceMap

pub fn get(&self, key: &Word) -> Option<&Arc<[Felt]>>

Returns the values associated with given key.

pub fn contains_key(&self, key: &Word) -> bool

Returns true if the key has a corresponding value in the map.

pub fn insert( &mut self, key: Word, value: impl Into<Arc<[Felt]>>, ) -> Option<Arc<[Felt]>>

Inserts a value, returning the previous value if the key was already set.

pub fn remove(&mut self, key: &Word) -> Option<Arc<[Felt]>>

Removes the value associated with the key and returns the removed element.

pub fn iter(&self) -> impl Iterator<Item = (&Word, &Arc<[Felt]>)>

Return an iteration over all entries in the map.

pub fn len(&self) -> usize

Returns the number of key value pairs in the advice map.

pub fn is_empty(&self) -> bool

Returns true if the advice map is empty.

pub fn entry(&mut self, key: Word) -> Entry<'_, Word, Arc<[Felt]>>

Gets the given key’s corresponding entry in the map for in-place manipulation.

pub fn merge( &mut self, other: &AdviceMap, ) -> Result<(), ((Word, Arc<[Felt]>), Arc<[Felt]>)>

Merges all entries from the given AdviceMap into the current advice map.

If an entry from the new map already exists with the same key but different value, an error is returned containing the existing entry along with the value that would replace it. The current map remains unchanged.

Trait Implementations

impl Arbitrary for AdviceMap

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<AdviceMap>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( _args: <AdviceMap as Arbitrary>::Parameters, ) -> <AdviceMap as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for AdviceMap

fn clone(&self) -> AdviceMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdviceMap

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

Formats the value using the given formatter.

impl Default for AdviceMap

fn default() -> AdviceMap

Returns the “default value” for a type.

impl Deserializable for AdviceMap

fn read_from<R>(source: &mut R) -> Result<AdviceMap, 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<'de> Deserialize<'de> for AdviceMap

fn deserialize<__D>( __deserializer: __D, ) -> Result<AdviceMap, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V> Extend<(Word, V)> for AdviceMap

where V: Into<Arc<[Felt]>>,

fn extend<I>(&mut self, iter: I)

where I: IntoIterator<Item = (Word, V)>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<BTreeMap<Word, Arc<[Felt]>>> for AdviceMap

fn from(value: BTreeMap<Word, Arc<[Felt]>>) -> AdviceMap

Converts to this type from the input type.

impl From<BTreeMap<Word, Vec<Felt>>> for AdviceMap

fn from(value: BTreeMap<Word, Vec<Felt>>) -> AdviceMap

Converts to this type from the input type.

impl<V> FromIterator<(Word, V)> for AdviceMap

where V: Into<Arc<[Felt]>>,

fn from_iter<I>(iter: I) -> AdviceMap

where I: IntoIterator<Item = (Word, V)>,

Creates a value from an iterator.

impl IntoIterator for AdviceMap

type Item = (Word, Arc<[Felt]>)

The type of the elements being iterated over.

type IntoIter = IntoIter<Word, Arc<[Felt]>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <AdviceMap as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for AdviceMap

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for AdviceMap

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AdviceMap

impl StructuralPartialEq for AdviceMap