Struct Library

pub struct Library { /* private fields */ }

Represents a set of imports for a single Program or Snippet, and moreover tracks some data used for initializing the memory allocator.

Implementations

impl Library

pub fn kmalloc_memory_region() -> MemoryRegion

pub fn new() -> Self

pub fn empty() -> Self

Create an empty library.

pub fn import(&mut self, snippet: Box<dyn BasicSnippet>) -> String

Import T: Snippet.

Recursively imports T’s dependencies. Does not import the snippets with the same entrypoint twice.

Avoid cyclic dependencies by only calling T::function_code() which may call .import() if .import::<T>() wasn’t already called once.

pub fn explicit_import( &mut self, name: &str, body: &[LabelledInstruction], ) -> String

Import code that does not implement the Snippet trait

If possible, you should use the import method as it gives better protections and allows you to test functions in isolation. This method is intended to add function to the assembly that you have defined inline and where a function call is needed due to e.g. a dynamic counter.

pub fn all_external_dependencies(&self) -> Vec<Vec<LabelledInstruction>>

Return a list of all external dependencies sorted by name. All snippets are sorted alphabetically to ensure that generated programs are deterministic.

pub fn get_all_snippet_names(&self) -> Vec<String>

Return the name of all imported snippets, sorted alphabetically to ensure that output is deterministic.

pub fn all_imports(&self) -> Vec<LabelledInstruction>

Return a list of instructions containing all imported snippets.

pub fn kmalloc(&mut self, num_words: u32) -> StaticAllocation

Statically allocate num_words words of memory.

Panics

Panics if

• num_words is zero,
• the total number of statically allocated words exceeds u32::MAX.

Trait Implementations

impl Clone for Library

fn clone(&self) -> Library

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Library

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

Formats the value using the given formatter.

impl Default for Library

fn default() -> Self

Returns the “default value” for a type.