Struct aluvm::Prog

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

The most trivial form of a program which is just a collection of libraries with some entry point.

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> Prog<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, ProgError>

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

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

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 ProgError::TooManyLibs otherwise.

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

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 crate::Vm::run)

Trait Implementations

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

fn clone(&self) -> Prog<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, const RUNTIME_MAX_TOTAL_LIBS: u16> Debug for Prog<Isa, RUNTIME_MAX_TOTAL_LIBS>where Isa: InstructionSet + Debug,

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

Formats the value using the given formatter.

impl<'de, Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> Deserialize<'de> for Prog<Isa, RUNTIME_MAX_TOTAL_LIBS>where Isa: InstructionSet,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

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<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> Ord for Prog<Isa, RUNTIME_MAX_TOTAL_LIBS>where Isa: InstructionSet + Ord,

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

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

fn eq(&self, other: &Prog<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: &Rhs) -> bool

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

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

fn partial_cmp( &self, other: &Prog<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, const RUNTIME_MAX_TOTAL_LIBS: u16> Program for Prog<Isa, RUNTIME_MAX_TOTAL_LIBS>where Isa: InstructionSet,

type Isa = Isa

Instruction set architecture used by the program.

type Iter<'a> = Values<'a, LibId, Lib> where Self: 'a

Iterator type over libraries

fn lib_count(&self) -> u16

Returns number of libraries used by the program.

fn libs(&self) -> Self::Iter<'_>

Returns an iterator over libraries used by the program.

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

Returns library corresponding to the provided LibId, if the library is known to the program.

fn entrypoint(&self) -> LibSite

Main entry point into the program.

impl<Isa, const RUNTIME_MAX_TOTAL_LIBS: u16> Serialize for Prog<Isa, RUNTIME_MAX_TOTAL_LIBS>where Isa: InstructionSet,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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

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