Struct noble_contracts::GasMeter

pub struct GasMeter<T: Config> { /* fields omitted */ }

Implementations

impl<T: Config> GasMeter<T>

pub fn new(gas_limit: Gas) -> Self

pub fn charge<Tok: Token<T>>(
    &mut self,
    metadata: &Tok::Metadata,
    token: Tok
) -> GasMeterResult

Account for used gas.

Amount is calculated by the given token.

Returns OutOfGas if there is not enough gas or addition of the specified amount of gas has lead to overflow. On success returns Proceed.

NOTE that amount is always consumed, i.e. if there is not enough gas then the counter will be set to zero.

pub fn refund(&mut self, amount: ChargedAmount)

Refund previously charged gas back to the gas meter.

This can be used if a gas worst case estimation must be charged before performing a certain action. This way the difference can be refundend when the worst case did not happen.

pub fn with_nested<R, F: FnOnce(Option<&mut GasMeter<T>>) -> R>(
    &mut self,
    amount: Gas,
    f: F
) -> R

Allocate some amount of gas and perform some work with a newly created nested gas meter.

Invokes f with either the gas meter that has amount gas left or with None, if this gas meter has not enough gas to allocate given amount.

All unused gas in the nested gas meter is returned to this gas meter.

pub fn gas_spent(&self) -> Gas

Returns how much gas was used.

pub fn gas_left(&self) -> Gas

Returns how much gas left from the initial budget.

pub fn into_dispatch_result<R, E>(
    self,
    result: Result<R, E>
) -> DispatchResultWithPostInfo where
    E: Into<ExecError>, 

Turn this GasMeter into a DispatchResult that contains the actually used gas.