Struct Gas 

pub struct Gas {
    pub gasLimit: u64,
    pub gasTotalUsed: u64,
    pub gasMemoryUsed: u64,
    pub gasRefunded: i64,
    pub gasRemaining: u64,
    pub gasStateUsed: i64,
}

Gas measured for the last completed call or create frame, from the callee’s perspective, including nested execution. Isolated transactions include intrinsic gas. Regular gas (the EIP’s execution gas) and EIP-8037 state gas are reported separately. Without EIP-8037, state creation uses the ordinary gas schedule and gasStateUsed is zero. See https://eips.ethereum.org/EIPS/eip-8037 and https://getfoundry.sh/reference/cheatcodes/last-frame-gas.

struct Gas { uint64 gasLimit; uint64 gasTotalUsed; uint64 gasMemoryUsed; int64 gasRefunded; uint64 gasRemaining; int64 gasStateUsed; }

Fields

gasLimit: u64

Regular gas available to the frame at entry. Excludes the EIP-8037 state gas reservoir.

gasTotalUsed: u64

Regular gas spent by the frame, before refunds. Excludes EIP-8037 state gas; see gasStateUsed. With isolation, includes intrinsic gas and the regular-gas calldata floor.

gasMemoryUsed: u64

DEPRECATED: always zero. Memory expansion costs are included in gasTotalUsed. Ref: https://github.com/foundry-rs/foundry/pull/7934#pullrequestreview-2069236939.

gasRefunded: i64

Ordinary refund counter before transaction settlement; finalized for an isolated transaction. Can be negative in nested frames. State gas refills are already netted into gasStateUsed.

gasRemaining: u64

Regular gas left at frame end. Excludes the EIP-8037 state gas reservoir. State charges can draw from this allowance, so gasLimit - gasRemaining can include state gas.

gasStateUsed: i64

Net EIP-8037 state gas: state creation charges minus refills, including nested execution. Zero without EIP-8037 or if the frame reverted or halted. Can be negative when the frame undoes state created earlier in the same transaction; use signed arithmetic with gasTotalUsed. Their sum measures net consumption, not the gas limit needed to execute.

Implementations

impl Gas

pub const STRUCT: &'static Struct<'static>

The struct definition.

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

Formats the value using the given formatter.

impl EventTopic for Gas

fn topic_preimage_length(rust: &Self::RustType) -> usize

The number of bytes this type occupies in another topic’s preimage, usually a multiple of 32.

fn encode_topic_preimage(rust: &Self::RustType, out: &mut Vec<u8>)

Encodes this type as preimage bytes which are then hashed in complex types’ [encode_topic][EventTopic::encode_topic].

fn encode_topic(rust: &Self::RustType) -> WordToken

Indexed event parameter encoding.

impl SolStruct for Gas

const NAME: &'static str = "Gas"

The struct name.

fn eip712_root_type() -> Cow<'static, str>

Return the root EIP-712 type. This type is used to construct the encodeType string.

fn eip712_components() -> Vec<Cow<'static, str>>

Returns component EIP-712 types. These types are used to construct the encodeType string. These are the types of the struct’s fields, and should not include the root type.

fn eip712_encode_type() -> Cow<'static, str>

The EIP-712-encoded type string.

fn eip712_encode_data(&self) -> Vec<u8>

Encodes this domain using EIP-712 encodeData.

fn eip712_type_hash(&self) -> FixedBytes<32>

Calculates the EIP-712 typeHash for this struct.

fn eip712_hash_struct(&self) -> FixedBytes<32>

Calculates the EIP-712 hashStruct for this value.

fn eip712_signing_hash(&self, domain: &Eip712Domain) -> FixedBytes<32>

Calculate the EIP-712 signing hash for this struct. Note that this does not sign the hash, only calculates it.

impl SolType for Gas

const SOL_NAME: &'static str = <Self as alloy_sol_types::SolStruct>::NAME

The name of this type in Solidity.

const ENCODED_SIZE: Option<usize> = <UnderlyingSolTuple as alloy_sol_types::SolType>::ENCODED_SIZE

The statically-known ABI-encoded size of the type.

const PACKED_ENCODED_SIZE: Option<usize> = <UnderlyingSolTuple as alloy_sol_types::SolType>::PACKED_ENCODED_SIZE

The statically-known Non-standard Packed Mode ABI-encoded size of the type.

type RustType = Gas

The corresponding Rust type.

type Token<'a> = <(Uint<64>, Uint<64>, Uint<64>, Int<64>, Uint<64>, Int<64>) as SolType>::Token<'a>

The corresponding ABI token type.

fn valid_token(token: &Self::Token<'_>) -> bool

Returns true if the given token can be detokenized with this type.

fn detokenize(token: Self::Token<'_>) -> Self::RustType

Detokenize this type’s value from the given token.

const DYNAMIC: bool = _

Whether the ABI-encoded size is dynamic.

fn abi_encoded_size<E>(rust: &E) -> usize

where E: SolTypeValue<Self> + ?Sized,

Calculate the ABI-encoded size of the data, counting both head and tail words. For a single-word type this will always be 32.

fn type_check(token: &Self::Token<'_>) -> Result<(), Error>

Returns an error if the given token cannot be detokenized with this type.

fn tokenize<E>(rust: &E) -> Self::Token<'_>

where E: SolTypeValue<Self> + ?Sized,

Tokenizes the given value into this type’s token.

fn eip712_data_word<E>(rust: &E) -> FixedBytes<32>

where E: SolTypeValue<Self> + ?Sized,

Encode this data according to EIP-712 encodeData rules, and hash it if necessary.

fn abi_packed_encoded_size<E>(rust: &E) -> usize

where E: SolTypeValue<Self> + ?Sized,

Returns the length of this value when ABI-encoded in Non-standard Packed Mode.

fn abi_encode_packed_to<E>(rust: &E, out: &mut Vec<u8>)

where E: SolTypeValue<Self> + ?Sized,

Non-standard Packed Mode ABI encoding.

fn abi_encode_packed<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized,

Non-standard Packed Mode ABI encoding.

fn abi_encode<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized,

Tokenizes and ABI-encodes the given value by wrapping it in a single-element sequence.

fn abi_encode_params<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized, Self::Token<'a>: for<'a> TokenSeq<'a>,

Tokenizes and ABI-encodes the given value as function parameters.

fn abi_encode_sequence<E>(rust: &E) -> Vec<u8>

where E: SolTypeValue<Self> + ?Sized, Self::Token<'a>: for<'a> TokenSeq<'a>,

Tokenizes and ABI-encodes the given value as a sequence.

fn abi_decode(data: &[u8]) -> Result<Self::RustType, Error>

Decodes this type’s value from an ABI blob by interpreting it as a single-element sequence.

fn abi_decode_with_config( data: &[u8], config: AbiDecoderConfig, ) -> Result<Self::RustType, Error>

Decodes this type’s value with a custom ABI decoder configuration.

fn abi_decode_validate(data: &[u8]) -> Result<Self::RustType, Error>

Decodes this type’s value from an ABI blob by interpreting it as single-element sequence, with validation.

fn abi_decode_params<'de>(data: &'de [u8]) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as function parameters.

fn abi_decode_params_with_config<'de>( data: &'de [u8], config: AbiDecoderConfig, ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s function parameters with a custom ABI decoder configuration.

fn abi_decode_params_validate<'de>( data: &'de [u8], ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as function parameters, with validation.

fn abi_decode_sequence<'de>(data: &'de [u8]) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as a sequence.

fn abi_decode_sequence_with_config<'de>( data: &'de [u8], config: AbiDecoderConfig, ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s sequence with a custom ABI decoder configuration.

fn abi_decode_sequence_validate<'de>( data: &'de [u8], ) -> Result<Self::RustType, Error>

where Self::Token<'de>: TokenSeq<'de>,

Decodes this type’s value from an ABI blob by interpreting it as sequence, with validation.

impl SolTypeValue<Gas> for Gas

fn stv_to_tokens(&self) -> <Self as SolType>::Token<'_>

fn stv_abi_encoded_size(&self) -> usize

fn stv_eip712_data_word(&self) -> Word

fn stv_abi_encode_packed_to(&self, out: &mut Vec<u8>)

fn stv_abi_packed_encoded_size(&self) -> usize

impl SolValue for Gas

type SolType = Gas

The Solidity type that this type corresponds to.

fn sol_name(&self) -> &'static str

The name of the associated Solidity type.

fn tokenize(&self) -> <Self::SolType as SolType>::Token<'_>

Tokenizes the given value into this type’s token.

fn detokenize(token: <Self::SolType as SolType>::Token<'_>) -> Self

where Self: From<<Self::SolType as SolType>::RustType>,

Detokenize a value from the given token.

fn abi_encoded_size(&self) -> usize

Calculate the ABI-encoded size of the data.

fn eip712_data_word(&self) -> FixedBytes<32>

Encode this data according to EIP-712 encodeData rules, and hash it if necessary.

fn abi_encode_packed_to(&self, out: &mut Vec<u8>)

Non-standard Packed Mode ABI encoding.

fn abi_encode_packed(&self) -> Vec<u8>

Non-standard Packed Mode ABI encoding.

fn abi_encode(&self) -> Vec<u8>

ABI-encodes the value.

fn abi_encode_sequence(&self) -> Vec<u8>

where <Self::SolType as SolType>::Token<'a>: for<'a> TokenSeq<'a>,

Encodes an ABI sequence.

fn abi_encode_params(&self) -> Vec<u8>

where <Self::SolType as SolType>::Token<'a>: for<'a> TokenSeq<'a>,

Encodes an ABI sequence suitable for function parameters.

fn abi_decode(data: &[u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>,

ABI-decode this type from the given data.

fn abi_decode_with_config( data: &[u8], config: AbiDecoderConfig, ) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>,

ABI-decode this type with a custom decoder configuration.

fn abi_decode_validate(data: &[u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>,

ABI-decode this type from the given data, with validation.

fn abi_decode_params<'de>(data: &'de [u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data.

fn abi_decode_params_with_config<'de>( data: &'de [u8], config: AbiDecoderConfig, ) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type’s function parameters with a custom decoder configuration.

fn abi_decode_params_validate<'de>(data: &'de [u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data, with validation.

fn abi_decode_sequence<'de>(data: &'de [u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data.

fn abi_decode_sequence_with_config<'de>( data: &'de [u8], config: AbiDecoderConfig, ) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type’s sequence with a custom decoder configuration.

fn abi_decode_sequence_validate<'de>(data: &'de [u8]) -> Result<Self, Error>

where Self: From<<Self::SolType as SolType>::RustType>, <Self::SolType as SolType>::Token<'de>: TokenSeq<'de>,

ABI-decode this type from the given data, with validation.

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: 48 bytes