Struct ra_ap_hir::SemanticsScope
source · pub struct SemanticsScope<'a> {
pub db: &'a dyn HirDatabase,
/* private fields */
}
Expand description
SemanticScope
encapsulates the notion of a scope (the set of visible
names) at a particular program point.
It is a bit tricky, as scopes do not really exist inside the compiler. Rather, the compiler directly computes for each reference the definition it refers to. It might transiently compute the explicit scope map while doing so, but, generally, this is not something left after the analysis.
However, we do very much need explicit scopes for IDE purposes – completion, at its core, lists the contents of the current scope. The notion of scope is also useful to answer questions like “what would be the meaning of this piece of code if we inserted it into this position?”.
So SemanticsScope
is constructed from a specific program point (a syntax
node or just a raw offset) and provides access to the set of visible names
on a somewhat best-effort basis.
Note that if you are wondering “what does this specific existing name mean?”,
you’d better use the resolve_
family of methods.
Fields§
§db: &'a dyn HirDatabase
Implementations§
source§impl<'a> SemanticsScope<'a>
impl<'a> SemanticsScope<'a>
pub fn module(&self) -> Module
pub fn krate(&self) -> Crate
sourcepub fn visible_traits(&self) -> VisibleTraits
pub fn visible_traits(&self) -> VisibleTraits
Note: VisibleTraits
should be treated as an opaque type, passed into `Type
pub fn process_all_names(&self, f: &mut dyn FnMut(Name, ScopeDef))
sourcepub fn speculative_resolve(&self, path: &Path) -> Option<PathResolution>
pub fn speculative_resolve(&self, path: &Path) -> Option<PathResolution>
Resolve a path as-if it was written at the given scope. This is necessary a heuristic, as it doesn’t take hygiene into account.
sourcepub fn assoc_type_shorthand_candidates<R>(
&self,
resolution: &PathResolution,
cb: impl FnMut(&Name, TypeAlias) -> Option<R>
) -> Option<R>
pub fn assoc_type_shorthand_candidates<R>(
&self,
resolution: &PathResolution,
cb: impl FnMut(&Name, TypeAlias) -> Option<R>
) -> Option<R>
Iterates over associated types that may be specified after the given path (using
Ty::Assoc
syntax).