Struct MultiGas 

pub struct MultiGas { /* private fields */ }

Multi-dimensional gas tracking.

Tracks gas usage per resource kind, a total, and a refund amount.

Implementations

impl MultiGas

pub const fn zero() -> Self

pub const fn from_raw(gas: [u64; 8], total: u64, refund: u64) -> Self

Construct from raw arrays (used in deserialization).

pub fn new(kind: ResourceKind, amount: u64) -> Self

pub fn from_pairs(pairs: &[(ResourceKind, u64)]) -> Self

Constructs from pairs of (ResourceKind, amount). Panics on overflow.

pub fn unknown_gas(amount: u64) -> Self

pub fn computation_gas(amount: u64) -> Self

pub fn history_growth_gas(amount: u64) -> Self

pub fn storage_access_gas(amount: u64) -> Self

pub fn storage_growth_gas(amount: u64) -> Self

pub fn l1_calldata_gas(amount: u64) -> Self

pub fn l2_calldata_gas(amount: u64) -> Self

pub fn wasm_computation_gas(amount: u64) -> Self

pub fn get(&self, kind: ResourceKind) -> u64

Returns the gas amount for the specified resource kind.

pub fn with(self, kind: ResourceKind, amount: u64) -> (Self, bool)

Returns a copy with the given resource kind set to amount. Returns (result, overflowed).

pub fn total(&self) -> u64

Returns the total gas across all dimensions.

pub fn single_gas(&self) -> u64

Returns the total gas as a single u64 value.

pub fn refund(&self) -> u64

Returns the refund amount.

pub fn with_refund(self, refund: u64) -> Self

Returns a copy with the refund set.

pub fn safe_add(self, x: MultiGas) -> (Self, bool)

Checked add. Returns (result, overflowed).

pub fn saturating_add(self, x: MultiGas) -> Self

Saturating add, returning a new value.

pub fn saturating_add_into(&mut self, other: MultiGas)

Saturating add of another MultiGas into self (in-place).

pub fn safe_sub(self, x: MultiGas) -> (Self, bool)

Checked subtract. Returns (result, underflowed).

pub fn saturating_sub(self, x: MultiGas) -> Self

Saturating subtract, returning a new value.

pub fn saturating_sub_into(&mut self, other: MultiGas)

Saturating subtract in place.

pub fn safe_increment(self, kind: ResourceKind, gas: u64) -> (Self, bool)

Checked increment of a single resource kind and total. Returns (result, overflowed).

pub fn saturating_increment(self, kind: ResourceKind, gas: u64) -> Self

Saturating increment of a single resource kind and total.

pub fn saturating_increment_into(&mut self, kind: ResourceKind, amount: u64)

Saturating increment in place (hot-path variant).

pub fn add_refund(&mut self, amount: u64)

Adds refund amount (saturating).

pub fn sub_refund(&mut self, amount: u64)

Subtracts from refund (saturating).

pub fn is_zero(&self) -> bool

Returns true if all fields are zero.

Trait Implementations

impl Add for MultiGas

type Output = MultiGas

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Clone for MultiGas

fn clone(&self) -> MultiGas

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiGas

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

Formats the value using the given formatter.

impl Default for MultiGas

fn default() -> MultiGas

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MultiGas

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl PartialEq for MultiGas

fn eq(&self, other: &MultiGas) -> 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 MultiGas

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Sub for MultiGas

type Output = MultiGas

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Copy for MultiGas

impl Eq for MultiGas

impl StructuralPartialEq for MultiGas