Struct Module

pub struct Module {
    pub code_object: Rc<CodeObject>,
    pub slots: Slots,
}

Main runtime representation for loadable modules.

Fields

code_object: Rc<CodeObject>

Always required. Shared object libraries will only fill the name and loc attribute.

slots: Slots

Contains CallProtocol entries that will be added to the context.

Implementations

impl Module

pub fn is_loadable<T>(path: T) -> Result<bool, Lovm2Error>

where T: AsRef<Path>,

A module is loadable if the first four bytes of the file are either the ELF magic number (shared object) or the lovm2 magic number LV2_MAGIC_NUMBER.

pub fn load_from_file<T>(path: T) -> Result<Module, Lovm2Error>

where T: AsRef<Path>,

Checks if the file is loadable and tries creating a module from it.

pub fn name(&self) -> &str

Returns the modules name.

pub fn location(&self) -> Option<&String>

Returns the filesystem path from which the module was created.

pub fn slots(&self) -> &Slots

pub fn slot(&self, name: &Variable) -> Option<Rc<dyn CallProtocol>>

Try looking up a Callable by name.

pub fn store_to_file<T>(&self, path: T) -> Result<(), Lovm2Error>

where T: AsRef<Path>,

Write the contained CodeObject into a file. This wil do nothing for shared object modules.

pub fn to_bytes(&self) -> Result<Vec<u8>, Lovm2Error>

Returns the CodeObject representation as bytes.

pub fn uses(&self) -> &[String]

List static dependencies of the module.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Display for Module

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

Formats the value using the given formatter.

impl From<CodeObject> for Module

fn from(code_object: CodeObject) -> Module

Converts to this type from the input type.