Struct gear_core::gas::GasCounter

pub struct GasCounter { /* private fields */ }

Gas counter with some predefined maximum gas.

Copy and Clone traits aren’t implemented for the type (however could be) in order to make the data only moveable, preventing explicit and implicit copying.

Implementations

impl GasCounter

pub fn new(initial_amount: u64) -> Self

New limited gas counter with initial gas to spend.

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

Account for used gas.

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> + Copy>( &mut self, amount: T, ) -> ChargeResult

Account for used gas.

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

pub fn increase(&mut self, amount: u64, _token: UnreservedReimbursement) -> bool

Increase left gas by amount.

Called when gas unreservation is occurred. We don’t decrease burn counter because GasTree manipulation is handled by separated function

pub fn reduce(&mut self, amount: u64) -> ChargeResult

Reduce gas by amount.

Called when message is sent to another program, so the gas amount is sent to receiving program. Or called when gas reservation is occurred.

In case of gas reservation: We don’t increase burn counter because GasTree manipulation is handled by separated function

pub fn left(&self) -> u64

Report how much gas is left.

pub fn burned(&self) -> u64

Report how much gas is burned.

pub fn to_amount(&self) -> GasAmount

Get gas amount.

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 Debug for GasCounter

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

Formats the value using the given formatter.