Struct Gas 

pub struct Gas { /* private fields */ }

Represents the state of gas during execution.

Implements the EIP-8037 reservoir model for dual-limit gas accounting:

• remaining: regular gas left (gas_left). Does NOT include reservoir.
• reservoir: state gas pool (separate from remaining). Starts as execution_gas - gas_left.
• state_gas_spent: tracks total state gas spent

Regular gas charges (record_cost): deduct from remaining, checked against remaining. State gas charges (record_state_cost): deduct from reservoir first; when exhausted, spill into remaining. Total gas available = remaining + reservoir.

On mainnet (no state gas), reservoir = 0 so all gas is regular gas and behavior is unchanged.

Implementations

impl Gas

pub const fn new(limit: u64) -> Gas

Creates a new Gas struct with the given gas limit.

Sets reservoir = 0 so all gas is regular gas (standard mainnet behavior).

pub const fn tracker(&self) -> &GasTracker

Returns the tracker for gas during execution.

pub const fn tracker_mut(&mut self) -> &mut GasTracker

Returns the mutable tracker for gas during execution.

pub const fn new_with_regular_gas_and_reservoir( limit: u64, reservoir: u64, ) -> Gas

Creates a new Gas struct with a regular gas budget and reservoir (EIP-8037 reservoir model).

Following the EIP-8037 spec:

• remaining = limit (regular gas available, i.e. gas_left)
• reservoir = state gas pool (separate from remaining)
• Total gas available = remaining + reservoir = limit + reservoir

Arguments

• limit: regular gas budget (capped execution gas, i.e. gas_left)
• reservoir: state gas pool (execution gas exceeding the regular gas cap)

pub const fn new_spent(limit: u64) -> Gas

Creates a new Gas struct with the given gas limit, but without any gas remaining.

pub const fn limit(&self) -> u64

Returns the gas limit.

pub fn memory(&self) -> &MemoryGas

Returns the memory gas.

pub fn memory_mut(&mut self) -> &mut MemoryGas

Returns the memory gas.

pub const fn refunded(&self) -> i64

Returns the total amount of gas that was refunded.

pub const fn spent(&self) -> u64

👎Deprecated since 32.0.0:

After EIP-8037 gas is split on regular and state gas, this method is no longer valid. Use Gas::total_gas_spent instead

Returns the total amount of gas spent.

pub const fn total_gas_spent(&self) -> u64

Returns the regular gas spent.

pub const fn used(&self) -> u64

Returns the final amount of gas used by subtracting the refund from spent gas.

pub const fn spent_sub_refunded(&self) -> u64

Returns the total amount of gas spent, minus the refunded gas.

pub const fn remaining(&self) -> u64

Returns the amount of gas remaining.

pub const fn reservoir(&self) -> u64

Returns the state gas reservoir.

pub fn set_reservoir(&mut self, val: u64)

Sets the state gas reservoir (used when propagating from child frame).

pub const fn state_gas_spent(&self) -> u64

Returns total state gas spent so far.

pub fn set_state_gas_spent(&mut self, val: u64)

Sets the total state gas spent (used when propagating from child frame).

pub fn erase_cost(&mut self, returned: u64)

Erases a gas cost from remaining (returns gas from child frame).

pub fn spend_all(&mut self)

Spends all remaining gas excluding the reservoir.

On exceptional halt, the remaining gas must be zeroed to prevent state operations from succeeding via remaining gas.

Note that this does not affect the reservoir.

pub fn record_refund(&mut self, refund: i64)

Records a refund value.

refund can be negative but self.refunded should always be positive at the end of transact.

pub fn set_final_refund(&mut self, is_london: bool)

Set a refund value for final refund.

Max refund value is limited to Nth part (depending of fork) of gas spend.

Related to EIP-3529: Reduction in refunds

pub fn set_refund(&mut self, refund: i64)

Set a refund value. This overrides the current refund value.

pub fn set_remaining(&mut self, remaining: u64)

Set a remaining value. This overrides the current remaining value.

pub fn set_spent(&mut self, spent: u64)

Set a spent value. This overrides the current spent value.

pub fn record_cost(&mut self, cost: u64) -> bool

👎Deprecated since 32.0.0:

use record_regular_cost instead

Records a regular gas cost (EIP-8037 reservoir model).

Deducts from remaining and checks against implicit gas_left budget. Regular gas charges cannot draw from the reservoir.

Returns false if the regular gas limit is exceeded. On failure, values contain wrapped (invalid) state — callers must not read after OOG.

pub fn record_cost_unsafe(&mut self, cost: u64) -> bool

Records an explicit cost without bounds checking (unsafe path).

Returns true if the gas limit is exceeded. Values wrap on underflow. Only the regular gas check is meaningful here; total remaining can underflow without consequence if the caller handles it.

pub fn record_state_cost(&mut self, cost: u64) -> bool

Records a state gas cost (EIP-8037 reservoir model).

State gas charges deduct from the reservoir first. If the reservoir is exhausted, remaining charges spill into gas_left (requiring total remaining >= cost). Tracks state gas spent.

Returns false if total remaining gas is insufficient.

pub fn record_regular_cost(&mut self, cost: u64) -> bool

Deducts from remaining only (used for child frame gas forwarding). Does not affect reservoir or regular gas budget. Used for forwarding gas to child frames.

Trait Implementations

impl Clone for Gas

fn clone(&self) -> Gas

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Gas

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

Formats the value using the given formatter.

impl Default for Gas

fn default() -> Gas

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Gas

fn deserialize<__D>( __deserializer: __D, ) -> Result<Gas, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Gas

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Gas

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Gas

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Gas

impl Eq for Gas

impl StructuralPartialEq for Gas

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 56 bytes