Struct lovm2_core::code::CodeObject

pub struct CodeObject {
    pub name: String,
    pub loc: Option<String>,
    pub uses: Vec<String>,
    pub entries: Vec<(usize, usize)>,
    pub consts: Vec<Value>,
    pub idents: Vec<Variable>,
    pub code: Vec<Instruction>,
}

CodeObject contains the bytecode as well as all the data used by it.

The entries attribute is a vector of name-offset pairs where the first component is an index into idents. This information is essential for the run_bytecode function used by CodeObjectFunction. It shouldn't be necessary to manually alter entries. By default, the subprogram named ENTRY_POINT will be at offset 0:

main:
    ...
    ret
add:
    ...
    ret

Values will be returned over the value stack. Every code object has to return some value on termination. If no value is produced, Nil is implicitly returned.

Fields

name: String

Name of the object. This is used as the modules name when imported.

loc: Option<String>

Location of objects origin.

uses: Vec<String>

Modules required for executing this object successfully.

entries: Vec<(usize, usize)>

Entry points for the bytecode in the form Vec<(index_into_idents, bytecode_offset)>. These are the functions of the module.

consts: Vec<Value>

Necessary constants.

idents: Vec<Variable>

Necessary identifiers.

code: Vec<Instruction>

Bytecode itself.

Implementations

impl CodeObject

pub fn new() -> Self

pub fn load_from_file<T>(path: T) -> Lovm2Result<Self> where
    T: AsRef<Path>, 

Tries to load the file as shared object first and falls back to regular deserialization if it failed

pub fn to_bytes(&self) -> Lovm2Result<Vec<u8>>

Return the objects representation as bytes

pub fn store_to_file<T>(&self, path: T) -> Lovm2Result<()> where
    T: AsRef<Path>, 

Write the object to a file at given path

Trait Implementations

impl CallProtocol for CodeObject

fn module(&self) -> Option<String>

fn run(&self, vm: &mut Vm) -> Lovm2Result<()>

impl Clone for CodeObject

fn clone(&self) -> CodeObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeObject

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

Formats the value using the given formatter.

impl Default for CodeObject

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for CodeObject

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

Deserialize this value from the given Serde deserializer.

impl From<CodeObject> for Module

fn from(code_object: CodeObject) -> Self

Performs the conversion.

impl Serialize for CodeObject

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

Serialize this value into the given Serde serializer.