Struct ActionList

pub struct ActionList { /* private fields */ }

A list of planned actions to be turned into a TransactionPlan.

A transaction is a bundle of actions plus auxiliary data (like a memo). A transaction plan is a bundle of action plans plus plans for the auxiliary data (like a memo plan). The ActionList is just the list of actions, which is useful for building up a TransactionPlan.

Implementations

impl ActionList

pub fn actions(&self) -> &Vec<ActionPlan>

Returns an immutable reference to a list of action plans.

pub fn change_outputs(&self) -> &BTreeMap<Id, OutputPlan>

Returns an immutable reference to a map of change outputs.

pub fn fee(&self) -> &Fee

Returns an immutable reference to the fee.

pub fn requires_memo(&self) -> bool

Returns true if the resulting transaction would require a memo.

pub fn into_plan<R: RngCore + CryptoRng>( self, rng: R, fmd_params: &Parameters, transaction_parameters: TransactionParameters, memo_plan: Option<MemoPlan>, ) -> Result<TransactionPlan>

Convert this list of actions into a TransactionPlan.

pub fn push<A: Into<ActionPlan>>(&mut self, action: A)

Push a new action onto this list.

pub fn refresh_fee_and_change<R: RngCore + CryptoRng>( &mut self, rng: R, gas_prices: &GasPrices, fee_tier: &FeeTier, change_address: &Address, )

Use the provided gas prices and fee tier to refresh the fee estimate for the transaction.

If the current fee estimate is too low, it will be increased. In that case, change notes will be adjusted to cover the increase if possible.

pub fn balance_without_fee(&self) -> Balance

Return the balance of the actions in the list, without accounting for fees.

pub fn balance_with_fee(&self) -> Balance

Return the balance of the actions in the list, minus the currently estimated fee required to pay their gas costs.

Trait Implementations

impl Clone for ActionList

fn clone(&self) -> ActionList

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ActionList

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

Formats the value using the given formatter.

impl Default for ActionList

fn default() -> ActionList

Returns the “default value” for a type.