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/vm/index.md#call-frames

Implementations

impl CallFrame

pub const fn new( to: ContractId, asset_id: AssetId, registers: [Word; 64], code_size: Word, 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) -> Word

Contract code length in bytes.

pub fn code_size_padding(&self) -> Word

Padding to the next word boundary.

pub fn total_code_size(&self) -> Word

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 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 MemLayout for CallFrame

type Type = CallFrameLayout

The associated memory layout type.

const LAYOUT: Self::Type = _

A constant instance of the memory layout.

const LEN: usize = 600usize

The length of the memory layout.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = u64

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = [u8; 512]

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = ContractId

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = AssetId

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = u64

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl MemLocType<{ <$o as $crate::MemLayout>::LAYOUT.$field.addr() }, { <$o as $crate::MemLayout>::LAYOUT.$field.size() }> for CallFrame

type Type = u64

The type at this memory location.

const ADDR: usize = ADDR

The memory locations address.

const SIZE: usize = SIZE

The memory locations size.

const LOC: MemLoc<ADDR, SIZE> = MemLoc::new()

The memory location.

fn layout(loc: MemLoc<ADDR, SIZE>) -> LayoutType<ADDR, SIZE, Self>

Combine a memory location and a type. This will only work if this trait is defined for the memory location.

impl PartialEq<CallFrame> 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 Read for CallFrame

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl SizedBytes for CallFrame

fn serialized_size(&self) -> usize

Return the expected serialized size for an instance of the type.

impl Write for CallFrame

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

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

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl Eq for CallFrame

impl StructuralEq for CallFrame

impl StructuralPartialEq for CallFrame