Struct AccountVaultPatch 

pub struct AccountVaultPatch { /* private fields */ }

Describes the updates to an AssetVault after a transaction.

The patch entries map an AssetId to the final Word value of the asset after the update. If the asset was removed, the value is Word::empty.

Implementations

impl AccountVaultPatch

pub fn new( entries: BTreeMap<AssetId, Word>, ) -> Result<AccountVaultPatch, AssetError>

Creates a new vault patch directly from its raw key/value entries.

Errors

Returns an error if the provided entries are not valid assets, unless the value is Word::empty.

pub fn insert_asset(&mut self, asset: Asset)

Inserts an asset into the patch, overwriting the previous value.

pub fn remove_asset(&mut self, asset_id: AssetId)

Marks an asset as removed by inserting Word::empty into the patch.

pub fn num_assets(&self) -> usize

Returns the number of assets being patched.

pub fn as_map(&self) -> &BTreeMap<AssetId, Word>

Returns a reference to the underlying map of the vault patch.

pub fn into_map(self) -> BTreeMap<AssetId, Word>

Consumes self and returns the underlying map of the vault patch.

pub fn iter(&self) -> impl Iterator<Item = (&AssetId, &Word)>

Returns an iterator over the assets contained in this patch, sorted by ID.

pub fn is_empty(&self) -> bool

Returns true if this vault patch contains no entries.

pub fn merge(&mut self, other: AccountVaultPatch)

Merges another vault patch into this one. Entries from other overwrite any existing entries in self for the same AssetId.

pub fn removed_asset_ids(&self) -> impl Iterator<Item = &AssetId>

Returns an iterator over the keys of assets that were removed (i.e. whose value is Word::empty).

pub fn updated_assets(&self) -> impl Iterator<Item = Asset>

Returns an iterator over the assets that were added or updated (i.e. whose value is not Word::empty).

Trait Implementations

impl Clone for AccountVaultPatch

fn clone(&self) -> AccountVaultPatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountVaultPatch

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

Formats the value using the given formatter.

impl Default for AccountVaultPatch

fn default() -> AccountVaultPatch

Returns the “default value” for a type.

impl Deserializable for AccountVaultPatch

fn read_from<R>( source: &mut R, ) -> Result<AccountVaultPatch, 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 Eq for AccountVaultPatch

impl PartialEq for AccountVaultPatch

fn eq(&self, other: &AccountVaultPatch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serializable for AccountVaultPatch

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

where W: ByteWriter,

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

fn get_size_hint(&self) -> usize

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

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

Serializes self into a vector of bytes.

impl StructuralPartialEq for AccountVaultPatch