bjoernager/rust
bjoernager/rust
1
Fork 0
Code Issues Pull requests Activity

Document ModuleData

Browse source 
* Convert comments on fields to doc comments so they're visible in API
  docs
* Add new documentation
* Get rid of "normal module" terminology
This commit is contained in:
Camelid 2020-12-27 16:53:57 -08:00
parent 8fec6c7bb9
commit 06931988c0
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

20
compiler/rustc_resolve/src/lib.rs
View file

@ -456,28 +456,36 @@ struct BindingKey {
type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>; type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
/// One node in the tree of modules. /// One node in the tree of modules.
///
/// Note that "module" is a loose term here; it does not necessarily mean
/// a `mod` that you declare in Rust code. It may also be, e.g., a trait
/// or an enum. See [`ModuleKind`] (accessible through [`ModuleData::kind`]
/// for all of the kinds of "modules" that resolve deals with.
pub struct ModuleData<'a> { pub struct ModuleData<'a> {
/// The direct parent module (it may not be a `mod`, however).
parent: Option<Module<'a>>, parent: Option<Module<'a>>,
/// What kind of module this is, because this may not be a `mod`.
kind: ModuleKind, kind: ModuleKind,
// The def id of the closest normal module (`mod`) ancestor (including this module). /// The [`DefId`] of the closest `mod` item ancestor (which may be this module), including crate root.
normal_ancestor_id: DefId, normal_ancestor_id: DefId,
// Mapping between names and their (possibly in-progress) resolutions in this module. /// Mapping between names and their (possibly in-progress) resolutions in this module.
// Resolutions in modules from other crates are not populated until accessed. /// Resolutions in modules from other crates are not populated until accessed.
lazy_resolutions: Resolutions<'a>, lazy_resolutions: Resolutions<'a>,
// True if this is a module from other crate that needs to be populated on access. /// True if this is a module from other crate that needs to be populated on access.
populate_on_access: Cell<bool>, populate_on_access: Cell<bool>,
// Macro invocations that can expand into items in this module. /// Macro invocations that can expand into items in this module.
unexpanded_invocations: RefCell<FxHashSet<ExpnId>>, unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
/// Whether `#[no_implicit_prelude]` is active.
no_implicit_prelude: bool, no_implicit_prelude: bool,
glob_importers: RefCell<Vec<&'a Import<'a>>>, glob_importers: RefCell<Vec<&'a Import<'a>>>,
globs: RefCell<Vec<&'a Import<'a>>>, globs: RefCell<Vec<&'a Import<'a>>>,
// Used to memoize the traits in this module for faster searches through all traits in scope. /// Used to memoize the traits in this module for faster searches through all traits in scope.
traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>, traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
/// Span of the module itself. Used for error reporting. /// Span of the module itself. Used for error reporting.