Struct ModuleDescriptor 

pub struct ModuleDescriptor { /* private fields */ }

Describes a MASM module surface, including its path, version, exports, and declared submodules.

Implementations

impl ModuleDescriptor

pub fn new(path: Arc<Path>, version: Option<Version>) -> Self

Returns a new ModuleDescriptor instantiated by library path and optional semantic version.

The semantic version is optional, as currently the assembler allows assembling artifacts without providing one.

pub fn set_version(&mut self, version: Version)

Specify the version of this module

pub fn add_procedure( &mut self, name: ProcedureName, digest: Word, signature: Option<Arc<FunctionType>>, attributes: AttributeSet, )

Adds a procedure to the module.

pub fn add_procedure_with_provenance( &mut self, name: ProcedureName, digest: Word, signature: Option<Arc<FunctionType>>, attributes: AttributeSet, source_root_id: Option<MastNodeId>, source_debug_root_id: Option<u32>, source_library_commitment: Option<Word>, )

Adds a procedure to the module with optional source provenance.

pub fn add_constant(&mut self, name: Ident, value: ConstantValue)

Adds a constant to the module.

pub fn add_type(&mut self, name: Ident, ty: Type)

Adds a type declaration to the module.

pub fn add_submodule(&mut self, submodule: SubmoduleDecl)

Adds a submodule declaration to the module surface.

pub fn path(&self) -> &Path

Returns the module’s library path.

pub fn num_procedures(&self) -> usize

Returns the number of procedures in the module.

pub fn get_item_by_index(&self, index: ItemIndex) -> Option<&ItemInfo>

Returns the ItemInfo of the item at the provided index, if any.

pub fn get_item_index_by_name(&self, name: &str) -> Option<ItemIndex>

Returns the ItemIndex of an item by its local name

pub fn get_procedure_by_name(&self, name: &str) -> Option<&ProcedureInfo>

Returns the procedure info for the procedure with the provided name, if any.

pub fn get_procedure_digest_by_name(&self, name: &str) -> Option<Word>

Returns the digest of the procedure with the provided name, if any.

pub fn items(&self) -> impl ExactSizeIterator<Item = (ItemIndex, &ItemInfo)>

Returns an iterator over the items in the module with their corresponding item index in the module.

pub fn submodules(&self) -> &[SubmoduleDecl]

Returns the declared submodules in this module surface.

pub fn procedures(&self) -> impl Iterator<Item = (ItemIndex, &ProcedureInfo)>

Returns an iterator over the procedure infos in the module with their corresponding item index in the module.

pub fn procedure_digests(&self) -> impl Iterator<Item = Word> + '_

Returns an iterator over the MAST roots of procedures defined in this module.

pub fn constants(&self) -> impl Iterator<Item = (ItemIndex, &ConstantInfo)>

Access the constants associated with this module

pub fn types(&self) -> impl Iterator<Item = (ItemIndex, &TypeInfo)>

Access the type declarations associated with this module

Trait Implementations

impl Clone for ModuleDescriptor

fn clone(&self) -> ModuleDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleDescriptor

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

Formats the value using the given formatter.

impl Eq for ModuleDescriptor

impl Index<ItemIndex> for ModuleDescriptor

type Output = ItemInfo

The returned type after indexing.

fn index(&self, index: ItemIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for ModuleDescriptor

fn eq(&self, other: &ModuleDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ModuleDescriptor

impl SymbolTable for &ModuleDescriptor

type SymbolIter = IntoIter<LocalSymbol>

The concrete iterator type for the container.

fn symbols(&self, _source_manager: Arc<dyn SourceManager>) -> Self::SymbolIter

Get an iterator over the symbols in this symbol table, using the provided SourceManager to emit errors for symbols which are invalid/unresolvable.

fn checked_symbols( &self, source_manager: Arc<dyn SourceManager>, ) -> Result<Self::SymbolIter, SymbolResolutionError>

Get an iterator over the symbols in this symbol table, returning a structured error if the full symbol set cannot be represented exactly.