Struct miden_objects::assembly::MaslLibrary

pub struct MaslLibrary { /* private fields */ }

A concrete implementation of the Library trait. Contains the minimal attributes of a functional library.

Implementers of the library trait should use this base type to perform serialization into masl files.

Implementations

impl MaslLibrary

pub const LIBRARY_EXTENSION: &'static str = "masl"

File extension for the Assembly Library.

pub const MODULE_EXTENSION: &'static str = "masm"

File extension for the Assembly Module.

pub const MOD: &'static str = "mod"

Name of the root module.

pub fn new( namespace: LibraryNamespace, version: Version, has_source_locations: bool, modules: Vec<Module>, dependencies: Vec<LibraryNamespace> ) -> Result<MaslLibrary, LibraryError>

Returns a new Library instantiated from the specified parameters.

Errors

Returns an error if the provided modules vector is empty or contains more than u16::MAX elements.

pub fn clear_locations(&mut self)

Clears the source locations from this bundle.

impl MaslLibrary

pub fn read_from_dir<P>( path: P, namespace: LibraryNamespace, with_source_locations: bool, version: Version ) -> Result<MaslLibrary, Error>

where P: AsRef<Path>,

Read a directory and recursively create modules from its masm files.

For every directory, concatenate the module path with the dir name and proceed.

For every file, pick and parse the ones with masm extension; skip otherwise.

Example:

• ./sys.masm -> (“sys”, ast(./sys.masm))
• ./crypto/hash.masm -> (“crypto::hash”, ast(./crypto/hash.masm))
• ./math/u32.masm -> (“math::u32”, ast(./math/u32.masm))
• ./math/u64.masm -> (“math::u64”, ast(./math/u64.masm))

pub fn read_from_file<P>(path: P) -> Result<MaslLibrary, LibraryError>

where P: AsRef<Path>,

Read a library from a file.

pub fn write_to_dir<P>(&self, dir_path: P) -> Result<(), Error>

where P: AsRef<Path>,

Write the library to a target director, using its namespace as file name and the appropriate extension.

Trait Implementations

impl Clone for MaslLibrary

fn clone(&self) -> MaslLibrary

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaslLibrary

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

Formats the value using the given formatter.

impl Deserializable for MaslLibrary

fn read_from<R>(source: &mut R) -> Result<MaslLibrary, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl Library for MaslLibrary

type ModuleIterator<'a> = Iter<'a, Module>

The concrete type used to iterate the modules of the library.

fn root_ns(&self) -> &LibraryNamespace

Returns the root namespace of this library.

fn version(&self) -> &Version

Returns the version number of this library.

fn modules(&self) -> <MaslLibrary as Library>::ModuleIterator<'_>

Iterate the modules available in the library.

fn dependencies(&self) -> &[LibraryNamespace]

Returns the dependency libraries of this library.

fn get_module_ast(&self, path: &LibraryPath) -> Option<&ModuleAst>

Returns the AST of the module stored at the provided path.

impl PartialEq for MaslLibrary

fn eq(&self, other: &MaslLibrary) -> 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 Serializable for MaslLibrary

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

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

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for MaslLibrary

impl StructuralPartialEq for MaslLibrary