Struct ra_ap_hir::Module

pub struct Module { /* fields omitted */ }

Implementations

impl Module

pub fn name(self, db: &dyn HirDatabase) -> Option<Name>

Name of this module.

pub fn krate(self) -> Crate

Returns the crate this module is part of.

pub fn crate_root(self, db: &dyn HirDatabase) -> Module

Topmost parent of this module. Every module has a crate_root, but some might be missing krate. This can happen if a module's file is not included in the module tree of any target in Cargo.toml.

pub fn children(self, db: &dyn HirDatabase) -> impl Iterator<Item = Module>

Iterates over all child modules.

pub fn parent(self, db: &dyn HirDatabase) -> Option<Module>

Finds a parent module.

pub fn path_to_root(self, db: &dyn HirDatabase) -> Vec<Module>

pub fn scope(
    self,
    db: &dyn HirDatabase,
    visible_from: Option<Module>
) -> Vec<(Name, ScopeDef)>

Returns a ModuleScope: a set of items, visible in this module.

pub fn visibility_of(
    self,
    db: &dyn HirDatabase,
    def: &ModuleDef
) -> Option<Visibility>

pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink<'_>)

pub fn declarations(self, db: &dyn HirDatabase) -> Vec<ModuleDef>

pub fn impl_defs(self, db: &dyn HirDatabase) -> Vec<ImplDef>

pub fn find_use_path(
    self,
    db: &dyn DefDatabase,
    item: impl Into<ItemInNs>
) -> Option<ModPath>

Finds a path that can be used to refer to the given item from within this module, if possible.

impl Module

NB: Module is !HasSource, because it has two source nodes at the same time: definition and declaration.

pub fn definition_source(self, db: &dyn HirDatabase) -> InFile<ModuleSource>

Returns a node which defines this module. That is, a file or a mod foo {} with items.

pub fn is_mod_rs(self, db: &dyn HirDatabase) -> bool

pub fn declaration_source(self, db: &dyn HirDatabase) -> Option<InFile<Module>>

Returns a node which declares this module, either a mod foo; or a mod foo {}. None for the crate root.

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 Copy for Module

impl Debug for Module

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

Formats the value using the given formatter.

impl Eq for Module

impl From<Module> for ModuleId

fn from(ty: Module) -> ModuleId

Performs the conversion.

impl From<Module> for ModuleDef

fn from(it: Module) -> ModuleDef

Performs the conversion.

impl From<ModuleId> for Module

fn from(id: ModuleId) -> Module

Performs the conversion.

impl HasAttrs for Module

fn attrs(self, db: &dyn HirDatabase) -> Attrs

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

fn resolve_doc_path(
    self,
    db: &dyn HirDatabase,
    link: &str,
    ns: Option<Namespace>
) -> Option<ModuleDef>

impl Hash for Module

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, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Module> for Module

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Module

impl StructuralPartialEq for Module