Struct fuel_vm::call::CallFrame

pub struct CallFrame { /* private fields */ }

Call frame representation in the VM stack.

https://github.com/FuelLabs/fuel-specs/blob/master/src/fuel-vm/index.md#call-frames

Implementations

impl CallFrame

pub const fn new( to: ContractId, asset_id: AssetId, registers: [Word; 64], code_size: usize, a: Word, b: Word, ) -> Self

Create a new call frame.

pub const fn contract_id_offset() -> usize

Start of the contract id offset from the beginning of the call frame.

pub const fn asset_id_offset() -> usize

Start of the asset id offset from the beginning of the call frame.

pub const fn registers_offset() -> usize

Start of the registers offset from the beginning of the call frame.

pub const fn code_size_offset() -> usize

Start of the code size offset from the beginning of the call frame.

pub const fn a_offset() -> usize

Start of the a argument offset from the beginning of the call frame.

pub const fn b_offset() -> usize

Start of the b argument offset from the beginning of the call frame.

pub const fn serialized_size() -> usize

Size of the call frame in bytes.

pub const fn registers(&self) -> &[Word]

Registers prior to the called execution.

pub const fn to(&self) -> &ContractId

Called contract id.

pub fn code_size(&self) -> usize

Contract code length in bytes.

pub fn code_size_padding(&self) -> usize

Padding to the next word boundary.

pub fn total_code_size(&self) -> usize

Total code size including padding.

pub const fn a(&self) -> Word

a argument.

pub const fn b(&self) -> Word

b argument.

pub fn context_gas(&self) -> Word

Gas context prior to the called execution.

pub const fn asset_id(&self) -> &AssetId

Asset ID of forwarded coins.

pub fn context_gas_mut(&mut self) -> &mut Word

Returns the mutable value of the context gas for this call frame.

pub fn global_gas_mut(&mut self) -> &mut Word

Returns the mutable value of the global gas for this call frame.

Trait Implementations

impl Clone for CallFrame

fn clone(&self) -> CallFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CallFrame

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

Formats the value using the given formatter.

impl Deserialize for CallFrame

fn decode_static<I: Input + ?Sized>(buffer: &mut I) -> Result<Self, Error>

Decodes static part of Self from the buffer.

fn decode_dynamic<I: Input + ?Sized>( &mut self, buffer: &mut I, ) -> Result<(), Error>

Decodes dynamic part of the information from the buffer to fill Self. The default implementation does nothing. Dynamically-sized contains should override this.

fn decode<I>(buffer: &mut I) -> Result<Self, Error>

where I: Input + ?Sized,

Decodes Self from the buffer.

fn from_bytes(buffer: &[u8]) -> Result<Self, Error>

Helper method for deserializing Self from bytes.

impl Hash for CallFrame

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

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 CallFrame

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CallFrame

fn size_static(&self) -> usize

Size of the static part of the serialized object, in bytes. Saturates to usize::MAX on overflow.

fn size_dynamic(&self) -> usize

Size of the dynamic part, in bytes. Saturates to usize::MAX on overflow.

fn encode_static<O: Output + ?Sized>(&self, buffer: &mut O) -> Result<(), Error>

Encodes staticly-sized part of Self.

fn encode_dynamic<O: Output + ?Sized>( &self, buffer: &mut O, ) -> Result<(), Error>

Encodes dynamically-sized part of Self. The default implementation does nothing. Dynamically-sized contains should override this.

fn size(&self) -> usize

Total size of the serialized object, in bytes. Saturates to usize::MAX on overflow.

fn encode<O>(&self, buffer: &mut O) -> Result<(), Error>

where O: Output + ?Sized,

Encodes Self into the buffer.

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

Encodes Self into bytes vector. Required known size.

impl Eq for CallFrame

impl StructuralPartialEq for CallFrame