Struct aluvm::Vm

pub struct Vm<E = ReservedOp> where
    E: InstructionSet,  { /* fields omitted */ }

Alu virtual machine providing single-core execution environment

Implementations

impl<E> Vm<E> where
    E: InstructionSet, 

pub fn libs_ref(&self) -> &BTreeMap<LibId, Lib<E>>

Method borrowing Vm::libs field. Libraries known to the runtime, identified by their hashes

pub fn entrypoint_ref(&self) -> &LibSite

Method borrowing Vm::entrypoint field. Entrypoint for the main function

pub fn registers_ref(&self) -> &Box<CoreRegs>

Method borrowing Vm::registers field. A set of registers

impl<E> Vm<E> where
    E: InstructionSet, 

pub fn new() -> Vm<E>

Constructs new virtual machine with no code in it.

Calling Vm::main on it will result in machine termination with st0 set to false.

pub fn with(lib: Lib<E>) -> Vm<E>

Constructs new virtual machine using the provided library.

pub fn add_lib(&mut self, lib: Lib<E>) -> bool

Adds Alu bytecode library to the virtual machine.

Returns

true if the library was already known and false otherwise.

pub fn set_entrypoint(&mut self, entrypoint: LibSite)

Sets new entry point value (used when calling Vm::main)

pub fn main(&mut self) -> bool

Executes the program starting from the provided entry point (set with Vm::set_entrypoint or initialized to 0 offset of the first used library if Vm::new, Vm::default or Vm::with were used).

Returns

Value of the st0 register at the end of the program execution.

pub fn call(&mut self, method: LibSite) -> bool

Executes the program starting from the provided entry point.

Returns

Value of the st0 register at the end of the program execution.

Trait Implementations

impl<E: Debug> Debug for Vm<E> where
    E: InstructionSet, 

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

Formats the value using the given formatter.

impl<E: Default> Default for Vm<E> where
    E: InstructionSet, 

fn default() -> Vm<E>

Returns the “default value” for a type.