Struct Module

pub struct Module {
    pub lexical_scopes: Vec<LexicalScope>,
    pub current_lexical_scope_id: LexicalScopeId,
    pub lexical_scopes_spans: HashMap<Span, LexicalScopeId>,
    pub is_external: bool,
    /* private fields */
}

A single Module within a Sway project.

A Module is most commonly associated with an individual file of Sway code, e.g. a top-level script/predicate/contract file or some library dependency whether introduced via mod or the [dependencies] table of a forc manifest.

A Module contains a set of all items that exist within the lexical scope via declaration or importing, along with a map of each of its submodules.

Fields

lexical_scopes: Vec<LexicalScope>

Keeps all lexical scopes associated with this module.

current_lexical_scope_id: LexicalScopeId

Current lexical scope id in the lexical scope hierarchy stack.

lexical_scopes_spans: HashMap<Span, LexicalScopeId>

Maps between a span and the corresponding lexical scope id.

is_external: bool

Indicates whether the module is external to the current package. External modules are imported in the Forc.toml file.

Implementations

impl Module

pub fn new(name: Ident, visibility: Visibility, span: Option<Span>) -> Self

pub fn name(&self) -> &Ident

pub fn visibility(&self) -> &Visibility

pub fn span(&self) -> &Option<Span>

pub fn set_span(&mut self, span: Span)

pub fn read<R>(&self, _engines: &Engines, f: impl FnMut(&Module) -> R) -> R

pub fn write<R>( &mut self, _engines: &Engines, f: impl FnMut(&mut Module) -> R, ) -> R

pub fn mod_path(&self) -> &ModulePath

pub fn mod_path_buf(&self) -> ModulePathBuf

pub fn submodules( &self, ) -> &HashMap<String, Module, BuildHasherDefault<FxHasher>>

Immutable access to this module’s submodules.

pub fn submodules_mut( &mut self, ) -> &mut HashMap<String, Module, BuildHasherDefault<FxHasher>>

Mutable access to this module’s submodules.

pub fn insert_submodule(&mut self, name: String, submodule: Module)

Insert a submodule into this Module.

pub fn submodule( &self, _engines: &Engines, path: &ModulePath, ) -> Option<&Module>

Lookup the submodule at the given path.

pub fn submodule_mut( &mut self, _engines: &Engines, path: &ModulePath, ) -> Option<&mut Module>

Unique access to the submodule at the given path.

pub fn root_lexical_scope_id(&self) -> LexicalScopeId

Returns the root lexical scope id associated with this module.

pub fn root_lexical_scope(&self) -> &LexicalScope

Returns the root lexical scope associated with this module.

pub fn current_lexical_scope(&self) -> &LexicalScope

Returns the current lexical scope associated with this module.

pub fn current_lexical_scope_mut(&mut self) -> &mut LexicalScope

Returns the mutable current lexical scope associated with this module.

pub fn current_items(&self) -> &Items

The collection of items declared by this module’s current lexical scope.

pub fn current_items_mut(&mut self) -> &mut Items

The mutable collection of items declared by this module’s current lexical scope.

pub fn current_lexical_scope_id(&self) -> LexicalScopeId

pub fn enter_lexical_scope( &mut self, handler: &Handler, _engines: &Engines, span: Span, ) -> Result<LexicalScopeId, ErrorEmitted>

Enters the scope with the given span in the module’s lexical scope hierarchy.

pub fn push_new_lexical_scope(&mut self, span: Span) -> LexicalScopeId

Pushes a new scope to the module’s lexical scope hierarchy.

pub fn pop_lexical_scope(&mut self)

Pops the current scope from the module’s lexical scope hierarchy.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy 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

Formats the value using the given formatter.

impl Default for Module

fn default() -> Self

Returns the “default value” for a type.

impl From<Module> for Root

fn from(module: Module) -> Self

Converts to this type from the input type.

impl From<Root> for Module

fn from(root: Root) -> Self

Converts to this type from the input type.