Struct aluvm::Program

pub struct Program<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16 = LIBS_MAX_TOTAL> where
    Isa: InstructionSet,  { /* private fields */ }

An AluVM program executable by a virtual machine.

Generics

RUNTIME_MAX_TOTAL_LIBS: Maximum total number of libraries supported by a runtime, if it is less than LIBS_MAX_TOTAL. If the value set is greater than LIBS_MAX_TOTAL the value is ignored and LIBS_MAX_TOTAL constant is used instead.

Implementations

impl<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

pub fn new(lib: Lib) -> Self

Constructs new virtual machine runtime using provided single library. Entry point is set to zero offset by default.

pub fn with(
    libs: impl IntoIterator<Item = Lib>,
    entrypoint: LibSite
) -> Result<Self, LibError>

Constructs new virtual machine runtime from a set of libraries with a given entry point.

pub fn lib(&self, id: LibId) -> Option<&Lib>

Returns reference to a specific library, if it is part of the current program.

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

Adds Alu bytecode library to the virtual machine runtime.

Errors

Checks requirement that the total number of libraries must not exceed LIBS_MAX_TOTAL and RUNTIME_MAX_TOTAL_LIBS - or returns LibError::TooManyLibs otherwise.

Checks that the ISA used by the VM supports ISA extensions specified by the library and returns LibError::IsaNotSupported otherwise.

Returns

true if the library was already known and false otherwise.

pub fn libs_count(&self) -> u16

Returns number of libraries used by the program.

pub fn entrypoint(&self) -> LibSite

Returns program entry point.

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

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

Trait Implementations

impl<Isa: Clone, const RUNTIME_MAX_TOTAL_LIBS: u16> Clone for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

fn clone(&self) -> Program<Isa, RUNTIME_MAX_TOTAL_LIBS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Isa: Debug, const RUNTIME_MAX_TOTAL_LIBS: u16> Debug for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

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

Formats the value using the given formatter.

impl<Isa: Hash, const RUNTIME_MAX_TOTAL_LIBS: u16> Hash for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

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, 

Feeds a slice of this type into the given Hasher.

impl<Isa: Ord, const RUNTIME_MAX_TOTAL_LIBS: u16> Ord for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

fn cmp(&self, other: &Program<Isa, RUNTIME_MAX_TOTAL_LIBS>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<Isa: PartialEq, const RUNTIME_MAX_TOTAL_LIBS: u16> PartialEq<Program<Isa, RUNTIME_MAX_TOTAL_LIBS>> for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

fn eq(&self, other: &Program<Isa, RUNTIME_MAX_TOTAL_LIBS>) -> bool

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

fn ne(&self, other: &Program<Isa, RUNTIME_MAX_TOTAL_LIBS>) -> bool

This method tests for !=.

impl<Isa: PartialOrd, const RUNTIME_MAX_TOTAL_LIBS: u16> PartialOrd<Program<Isa, RUNTIME_MAX_TOTAL_LIBS>> for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

fn partial_cmp(
    &self,
    other: &Program<Isa, RUNTIME_MAX_TOTAL_LIBS>
) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Isa: Eq, const RUNTIME_MAX_TOTAL_LIBS: u16> Eq for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

impl<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> StructuralEq for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet, 

impl<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> StructuralPartialEq for Program<Isa, RUNTIME_MAX_TOTAL_LIBS> where
    Isa: InstructionSet,