Struct fuel_vm::interpreter::RuntimeBalances

pub struct RuntimeBalances { /* private fields */ }

Structure to encapsulate asset balances for VM runtime

Implementations

impl RuntimeBalances

pub fn try_from_iter<T>(iter: T) -> Result<Self, CheckError>where
    T: IntoIterator<Item = (AssetId, Word)>,

Attempt to create a set of runtime balances from an iterator of pairs.

This will fail if, and only if, the provided asset/balance pair isn’t consistent or a balance overflows.

pub fn balance(&self, asset: &AssetId) -> Option<Word>

Fetch the balance of a given Id, if set.

pub fn checked_balance_add(
    &mut self,
    memory: &mut [u8],
    asset: &AssetId,
    value: Word
) -> Option<Word>

Attempt to add the balance of an asset, updating the VM memory in the appropriate offset

Note: This will not append a new asset into the set since all the assets must be created during VM initialization and any additional asset would imply reordering the memory representation of the balances since they must always be ordered, as in the protocol.

pub fn checked_balance_sub(
    &mut self,
    memory: &mut [u8],
    asset: &AssetId,
    value: Word
) -> Option<Word>

Attempt to subtract the balance of an asset, updating the VM memory in the appropriate offset

pub fn to_vm<S, Tx>(self, vm: &mut Interpreter<S, Tx>)where
    Tx: ExecutableTransaction,

Write all assets into the VM memory.

Trait Implementations

impl Clone for RuntimeBalances

fn clone(&self) -> RuntimeBalances

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeBalances

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

Formats the value using the given formatter.

impl Default for RuntimeBalances

fn default() -> RuntimeBalances

Returns the “default value” for a type.

impl From<BTreeMap<AssetId, u64, Global>> for RuntimeBalances

fn from(balances: InitialBalances) -> Self

Converts to this type from the input type.

impl Index<&AssetId> for RuntimeBalances

type Output = u64

The returned type after indexing.

fn index(&self, index: &AssetId) -> &Self::Output

Performs the indexing (container[index]) operation.