Struct hir::Module

pub struct Module { /* private fields */ }

Implementations

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 definition_source_range(self, db: &dyn HirDatabase) -> InFile<TextRange>

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

pub fn definition_source_file_id(self, db: &dyn HirDatabase) -> HirFileId

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

pub fn as_source_file_id(self, db: &dyn HirDatabase) -> Option<EditionedFileId>

pub fn is_inline(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.

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

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

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 is_crate_root(self) -> bool

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 nearest_non_block_module(self, db: &dyn HirDatabase) -> Module

Finds nearest non-block ancestor Module (self included).

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 diagnostics( self, db: &dyn HirDatabase, acc: &mut Vec<AnyDiagnostic>, style_lints: bool, )

Fills acc with the module’s diagnostics.

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

pub fn legacy_macros(self, db: &dyn HirDatabase) -> Vec<Macro>

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

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

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

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

Finds a path that can be used to refer to the given item from within this module, if possible. This is used for returning import paths for use-statements.

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 From<Module> for ModuleDef

fn from(it: Module) -> ModuleDef

Converts to this type from the input type.

impl From<Module> for ModuleId

fn from(ty: Module) -> ModuleId

Converts to this type from the input type.

impl From<ModuleId> for Module

fn from(id: ModuleId) -> Module

Converts to this type from the input type.

impl HasAttrs for Module

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

impl HasContainer for Module

fn container(&self, db: &dyn HirDatabase) -> ItemContainer

impl HasCrate for Module

fn krate(&self, _: &dyn HirDatabase) -> Crate

impl HasVisibility for Module

fn visibility(&self, db: &dyn HirDatabase) -> Visibility

fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HirDisplay for Module

fn hir_fmt(&self, f: &mut HirFormatter<'_>) -> Result<(), HirDisplayError>

fn into_displayable<'a>( &'a self, db: &'a dyn HirDatabase, max_size: Option<usize>, limited_size: Option<usize>, omit_verbose_types: bool, display_target: DisplayTarget, closure_style: ClosureStyle, show_container_bounds: bool, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable.

fn display<'a>( &'a self, db: &'a dyn HirDatabase, edition: Edition, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable. Use this for showing types to the user (e.g. diagnostics)

fn display_truncated<'a>( &'a self, db: &'a dyn HirDatabase, max_size: Option<usize>, edition: Edition, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to be succinct. Use this for showing types to the user where space is constrained (e.g. doc popups)

fn display_limited<'a>( &'a self, db: &'a dyn HirDatabase, limited_size: Option<usize>, edition: Edition, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to limit the number of items inside. Use this for showing definitions which may contain too many items, like trait, struct, enum

fn display_source_code<'a>( &'a self, db: &'a dyn HirDatabase, module_id: ModuleId, allow_opaque: bool, ) -> Result<String, DisplaySourceCodeError>

Returns a String representation of self that can be inserted into the given module. Use this when generating code (e.g. assists)

fn display_test<'a>( &'a self, db: &'a dyn HirDatabase, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a String representation of self for test purposes

fn display_with_container_bounds<'a>( &'a self, db: &'a dyn HirDatabase, show_container_bounds: bool, edition: Edition, ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a String representation of self that shows the constraint from the container for functions

impl PartialEq for Module

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

impl Eq for Module

impl StructuralPartialEq for Module