Struct fuel_vm::interpreter::Interpreter

source · [−]

pub struct Interpreter<S> { /* private fields */ }

Expand description

VM interpreter.

The internal state of the VM isn’t expose because the intended usage is to either inspect the resulting receipts after a transaction execution, or the resulting mutated transaction.

These can be obtained with the help of a crate::transactor::Transactor or a client implementation.

Implementations

impl<S> Interpreter<S>

pub fn with_storage(storage: S) -> Self

Create a new interpreter instance out of a storage implementation.

If the provided storage implements crate::storage::InterpreterStorage, the returned interpreter will provide full functionality.

impl Interpreter<()>

pub fn without_storage() -> Self

Create a new interpreter without a storage backend.

It will have restricted capabilities.

impl Interpreter<MemoryStorage>

pub fn with_memory_storage() -> Self

Create a new storage with a provided in-memory storage.

It will have full capabilities.

impl<S> Interpreter<S> where
S: InterpreterStorage,

pub fn execute(&mut self) -> Result<ExecuteState, InterpreterError>

Execute the current instruction pair located in $m[$pc].

pub fn instruction(
&mut self,
instruction: Instruction
) -> Result<ExecuteState, InterpreterError>

Execute a provided instruction

impl<S> Interpreter<S> where
S: InterpreterStorage,

pub fn transact_owned(
storage: S,
tx: Transaction
) -> Result<StateTransition, InterpreterError>

Allocate internally a new instance of Interpreter with the provided storage, initialize it with the provided transaction and return the result of th execution in form of StateTransition

pub fn transact(
&mut self,
tx: Transaction
) -> Result<StateTransitionRef<'_>, InterpreterError>

Initialize a pre-allocated instance of Interpreter with the provided transaction and execute it. The result will be bound to the lifetime of the interpreter and will avoid unnecessary copy with the data that can be referenced from the interpreter instance itself.

impl<S> Interpreter<S>

pub fn memory(&self) -> &[u8 ]ⓘNotable traits for &'_ [u8 ]`impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]`

Returns the current state of the VM memory

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

Returns the current state of the registers

pub const fn debugger(&self) -> &Debugger

Debug handler

pub fn receipts(&self) -> &[Receipt ]

Receipts generated by a transaction execution.

Trait Implementations

impl<S> AsMut<S> for Interpreter<S>

fn as_mut(&mut self) -> &mut S

Performs the conversion.

impl<S> AsRef<Interpreter<S>> for Transactor<'_, S>

fn as_ref(&self) -> &Interpreter<S>

Performs the conversion.

impl<S> AsRef<S> for Interpreter<S>

fn as_ref(&self) -> &S

Performs the conversion.

impl<S: Clone> Clone for Interpreter<S>

fn clone(&self) -> Interpreter<S>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<S: Debug> Debug for Interpreter<S>

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

Formats the value using the given formatter. Read more

impl<S> Default for Interpreter<S> where
S: Default,

fn default() -> Self

Returns the “default value” for a type. Read more

impl<S> From<Interpreter<S>> for Transaction

fn from(vm: Interpreter<S>) -> Self

Performs the conversion.

impl<S> From<Interpreter<S>> for Transactor<'_, S>

fn from(interpreter: Interpreter<S>) -> Self

Performs the conversion.

impl<S> From<Transactor<'_, S>> for Interpreter<S>

fn from(transactor: Transactor<'_, S>) -> Self

Performs the conversion.

Auto Trait Implementations

impl<S> RefUnwindSafe for Interpreter<S> where
S: RefUnwindSafe,

impl<S> Send for Interpreter<S> where
S: Send,

impl<S> Sync for Interpreter<S> where
S: Sync,

impl<S> Unpin for Interpreter<S> where
S: Unpin,

impl<S> UnwindSafe for Interpreter<S> where
S: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToHex for T where
T: AsRef<[u8 ]>,

fn encode_hex<U>(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Lower case letters are used (e.g. f9b4ca) Read more

fn encode_hex_upper<U>(&self) -> U where
U: FromIterator<char>,

Encode the hex strict representing self into the result. Upper case letters are used (e.g. F9B4CA) Read more

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.