Struct ModuleId

pub struct ModuleId(/* private fields */);

Id of a Module, which corresponds to a single Fe source file.

Implementations

impl ModuleId

pub fn new_standalone( db: &mut dyn AnalyzerDb, path: &str, content: &str, ) -> Self

pub fn new( db: &dyn AnalyzerDb, name: &str, source: ModuleSource, ingot: IngotId, ) -> Self

pub fn data(&self, db: &dyn AnalyzerDb) -> Rc<Module>

pub fn name(&self, db: &dyn AnalyzerDb) -> SmolStr

pub fn file_path_relative_to_src_dir(&self, db: &dyn AnalyzerDb) -> SmolStr

pub fn ast(&self, db: &dyn AnalyzerDb) -> Rc<Module>

pub fn ingot(&self, db: &dyn AnalyzerDb) -> IngotId

pub fn is_incomplete(&self, db: &dyn AnalyzerDb) -> bool

pub fn is_in_std(&self, db: &dyn AnalyzerDb) -> bool

pub fn all_items(&self, db: &dyn AnalyzerDb) -> Rc<[Item]>

Includes duplicate names

pub fn all_impls(&self, db: &dyn AnalyzerDb) -> Rc<[ImplId]>

Includes duplicate names

pub fn impls( &self, db: &dyn AnalyzerDb, ) -> Rc<IndexMap<(TraitId, TypeId), ImplId>>

pub fn items(&self, db: &dyn AnalyzerDb) -> Rc<IndexMap<SmolStr, Item>>

Returns a map of the named items in the module

pub fn used_items( &self, db: &dyn AnalyzerDb, ) -> Rc<IndexMap<SmolStr, (Span, Item)>>

Returns a name -> (name_span, external_item) map for all use statements in a module.

pub fn tests(&self, db: &dyn AnalyzerDb) -> Vec<FunctionId>

pub fn is_in_scope(&self, db: &dyn AnalyzerDb, item: Item) -> bool

Returns true if the item is in scope of the module.

pub fn non_used_internal_items( &self, db: &dyn AnalyzerDb, ) -> IndexMap<SmolStr, Item>

Returns all of the internal items, except for used items. This is used when resolving use statements, as it does not create a query cycle.

pub fn internal_items(&self, db: &dyn AnalyzerDb) -> IndexMap<SmolStr, Item>

Returns all of the internal items. Internal items refers to the set of items visible when inside of a module.

pub fn resolve_path( &self, db: &dyn AnalyzerDb, path: &Path, ) -> Analysis<Option<NamedThing>>

Resolve a path that starts with an item defined in the module.

pub fn resolve_path_non_used_internal( &self, db: &dyn AnalyzerDb, path: &Path, ) -> Analysis<Option<NamedThing>>

Resolve a path that starts with an internal item. We omit used items to avoid a query cycle.

pub fn resolve_path_internal( &self, db: &dyn AnalyzerDb, path: &Path, ) -> Analysis<Option<NamedThing>>

Resolve a path that starts with an internal item.

pub fn resolve_name( &self, db: &dyn AnalyzerDb, name: &str, ) -> Result<Option<NamedThing>, IncompleteItem>

Returns Err(IncompleteItem) if the name could not be resolved, and the module was not completely parsed (due to a syntax error).

pub fn resolve_constant( &self, db: &dyn AnalyzerDb, name: &str, ) -> Result<Option<ModuleConstantId>, IncompleteItem>

pub fn submodules(&self, db: &dyn AnalyzerDb) -> Rc<[ModuleId]>

pub fn parent(&self, db: &dyn AnalyzerDb) -> Item

pub fn parent_module(&self, db: &dyn AnalyzerDb) -> Option<ModuleId>

pub fn all_contracts(&self, db: &dyn AnalyzerDb) -> Vec<ContractId>

All contracts, including from submodules and including duplicates

pub fn all_functions(&self, db: &dyn AnalyzerDb) -> Vec<FunctionId>

All functions, including from submodules and including duplicates

pub fn global_items(&self, db: &dyn AnalyzerDb) -> IndexMap<SmolStr, Item>

Returns the map of ingot deps, built-ins, and the ingot itself as “ingot”.

pub fn all_constants(&self, db: &dyn AnalyzerDb) -> Rc<Vec<ModuleConstantId>>

All module constants.

pub fn diagnostics(&self, db: &dyn AnalyzerDb) -> Vec<Diagnostic>

pub fn sink_diagnostics( &self, db: &dyn AnalyzerDb, sink: &mut impl DiagnosticSink, )

Trait Implementations

impl Clone for ModuleId

fn clone(&self) -> ModuleId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleId

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

Formats the value using the given formatter.

impl Hash for ModuleId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl InternKey for ModuleId

fn from_intern_id(v: InternId) -> Self

Create an instance of the intern-key from a u32 value.

fn as_intern_id(&self) -> InternId

Extract the u32 with which the intern-key was created.

impl Ord for ModuleId

fn cmp(&self, other: &ModuleId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ModuleId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ModuleId

fn partial_cmp(&self, other: &ModuleId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ModuleId

impl Eq for ModuleId

impl StructuralPartialEq for ModuleId