Struct miden_assembly::ast::ModuleImports

pub struct ModuleImports { /* private fields */ }

Information about imports stored in the AST

Implementations

impl ModuleImports

pub fn new( imports: BTreeMap<String, LibraryPath>, invoked_procs: BTreeMap<ProcedureId, (ProcedureName, LibraryPath)> ) -> Self

Create a new ModuleImports instance

Panics

Panics if the number of imports is greater than MAX_IMPORTS, or if the number of invoked procedures is greater than MAX_INVOKED_IMPORTED_PROCS

pub fn parse(tokens: &mut TokenStream<'_>) -> Result<Self, ParsingError>

Parses all use statements into a map of imports which maps a module name (e.g., “u64”) to its fully-qualified path (e.g., “std::math::u64”).

pub fn is_empty(&self) -> bool

Returns true if there are no imports in the containing module

pub fn len(&self) -> usize

Returns the number of imports contained in this table

pub fn get_module_path(&self, module_name: &str) -> Option<&LibraryPath>

Look up the path of the imported module with the given name.

pub fn get_procedure_info( &self, id: &ProcedureId ) -> Option<(&ProcedureName, &LibraryPath)>

Look up the actual procedure name and module path associated with the given ProcedureId, if that procedure was imported and invoked in the current module.

pub fn get_procedure_name(&self, id: &ProcedureId) -> Option<&ProcedureName>

Look up the procedure name associated with the given ProcedureId, if that procedure was imported and invoked in the current module.

pub fn get_procedure_path(&self, id: &ProcedureId) -> Option<&LibraryPath>

Look up the LibraryPath associated with the given ProcedureId, if that procedure was imported and invoked in the current module.

pub fn import_paths(&self) -> Vec<&LibraryPath>

Return the paths of all imported module

pub fn get_imported_procedures(&self) -> BTreeMap<ProcedureId, ProcedureName>

Returns a map containing IDs and names of imported procedures.

pub fn add_invoked_proc( &mut self, proc_name: &ProcedureName, module_name: &str, token: &Token<'_> ) -> Result<ProcedureId, ParsingError>

Adds the specified procedure to the set of procedures invoked from imported modules and returns the ID of the invoked procedure.

Errors

Return an error if

• The module with the specified name has not been imported via the use statement.
• The total number of invoked procedures exceeds 2^{16} - 1.

pub fn clear(&mut self)

Clears all stored information about imported modules and invoked procedures

Trait Implementations

impl Clone for ModuleImports

fn clone(&self) -> ModuleImports

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleImports

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

Formats the value using the given formatter.

impl Default for ModuleImports

fn default() -> ModuleImports

Returns the “default value” for a type.

impl Deserializable for ModuleImports

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

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 PartialEq for ModuleImports

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

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

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 ModuleImports

impl StructuralPartialEq for ModuleImports