Struct GasMeter 

pub struct GasMeter { /* private fields */ }

Struct to keep track of gas usage

Implementations

impl GasMeter

pub const RESERVE_PERCENTAGE: u64 = 93u64

Default percentage of gas to be given to a GasMeter when limited is called.

pub fn with_limit(limit: Gas) -> GasMeter

Creates a new GasMeter with given gas limits

pub fn charge(&mut self, amount: Gas) -> Result<(), GasError>

Deduct specified amount of gas from the meter

pub fn set_left(&mut self, new_left: Gas)

Mutates the left gas amount

pub fn left(&self) -> Gas

Returns how much gas left from the initial budget.

pub fn limit(&self) -> Gas

Returns the gas limit.

pub fn spent(&self) -> Gas

Returns how much gas was actually spent.

pub fn limited(&self, limit: Gas) -> GasMeter

Create a new limited GasMeter. If limit parameter is 0, default limit is assumed that satisfies the requirement for obligatory gas reserve (Self::RESERVE_PERCENTAGE of the gas left). The limit provided cannot exceed the gas left, if that happens the total amount of gas is used as limit.

Trait Implementations

impl Clone for GasMeter

fn clone(&self) -> GasMeter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GasMeter

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

Formats the value using the given formatter.