Struct GasAllowanceCounter

pub struct GasAllowanceCounter(/* private fields */);

Gas allowance counter with some predefined maximum value.

Implementations

impl GasAllowanceCounter

pub fn new(initial_amount: u64) -> Self

New limited gas allowance counter with initial value to spend.

pub fn left(&self) -> u64

Report how much gas allowance is left.

pub fn charge<T: Into<u64>>(&mut self, amount: T) -> ChargeResult

Account for used gas allowance.

If there is no enough gas, then makes saturating charge and returns NotEnough. Else charges gas and returns Enough.

pub fn charge_if_enough<T: Into<u64>>(&mut self, amount: T) -> ChargeResult

Account for used gas allowance.

If there is no enough gas, then does nothing and returns ChargeResult::NotEnough. Else charges gas and returns ChargeResult::Enough.

pub unsafe fn clone(&self) -> Self

Clone the counter

Safety

Use only when it’s absolutely necessary to clone the counter i.e atomic implementation of Ext.

Trait Implementations

impl Clone for GasAllowanceCounter

fn clone(&self) -> GasAllowanceCounter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GasAllowanceCounter

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

Formats the value using the given formatter.