Struct cosmwasm_vm::GasInfo

pub struct GasInfo {
    pub cost: u64,
    pub externally_used: u64,
}

A structure that represents gas cost to be deducted from the remaining gas. This is always needed when computations are performed outside of Wasm execution, such as calling crypto APIs or calls into the blockchain.

All values are measured in CosmWasm gas.

Fields

cost: u64

The gas cost of a computation that was executed already but not yet charged.

This could be renamed to internally_used for consistency because it is used inside of the cosmwasm_vm.

externally_used: u64

Gas that was used and charged externally. This is needed to adjust the VM’s gas limit but does not affect the gas usage.

Since this is measured in CosmWasm gas, the caller may need to convert from Cosmos SDK gas in cases where an SDK gas meter is used.

Implementations

impl GasInfo

pub fn new(cost: u64, externally_used: u64) -> Self

pub fn with_cost(amount: u64) -> Self

pub fn with_externally_used(amount: u64) -> Self

pub fn free() -> Self

Creates a gas information with no cost for the caller and with zero externally used gas.

Caution: when using this you need to make sure no gas was metered externally to keep the gas values in sync.

Trait Implementations

impl AddAssign for GasInfo

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for GasInfo

fn clone(&self) -> GasInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GasInfo

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

Formats the value using the given formatter.

impl PartialEq for GasInfo

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for GasInfo

impl Eq for GasInfo

impl StructuralPartialEq for GasInfo