pub struct ProjectIndex {
pub symbols: HashMap<SymbolKey, SymbolEntry>,
pub foreign_refs: Vec<ForeignRef>,
pub calls: Vec<CallEdge>,
pub impls: Vec<ImplEdge>,
}Expand description
The project-wide binding index: every in-scope symbol’s definition and references, keyed structurally. Built by the v0.24 project pass in analyse mode; empty in build mode.
Fields§
§symbols: HashMap<SymbolKey, SymbolEntry>§foreign_refs: Vec<ForeignRef>v0.28 (ADR 0057): references to first-party symbols, sorted by
(path, span), deduplicated — read only by the semantic-tokens
producer (see ForeignRef).
calls: Vec<CallEdge>v0.34 (ADR 0067): caller→callee call edges (Fn callees only), sorted
by (caller, callee, site). The call-hierarchy graph (see CallEdge).
impls: Vec<ImplEdge>v0.35 (ADR 0068): capability→provider implementation edges, sorted by
(capability, provider, site). The implementation-nav graph (see
ImplEdge).
Implementations§
Source§impl ProjectIndex
impl ProjectIndex
Sourcepub fn symbol_at(
&self,
path: &Path,
offset: usize,
) -> Option<(&SymbolKey, &SiteRef)>
pub fn symbol_at( &self, path: &Path, offset: usize, ) -> Option<(&SymbolKey, &SiteRef)>
The symbol whose definition or reference name-segment contains
offset within path. Spans are half-open; name segments never
overlap, so the first hit is the only hit.
Sourcepub fn sites(&self, key: &SymbolKey) -> Vec<&SiteRef>
pub fn sites(&self, key: &SymbolKey) -> Vec<&SiteRef>
Definition + references for key, definition first.
Sourcepub fn calls_into<'a>(
&'a self,
key: &SymbolKey,
) -> impl Iterator<Item = &'a CallEdge>
pub fn calls_into<'a>( &'a self, key: &SymbolKey, ) -> impl Iterator<Item = &'a CallEdge>
v0.34 (ADR 0067): call edges whose callee is key — its callers.
Sourcepub fn calls_from<'a>(
&'a self,
key: &SymbolKey,
) -> impl Iterator<Item = &'a CallEdge>
pub fn calls_from<'a>( &'a self, key: &SymbolKey, ) -> impl Iterator<Item = &'a CallEdge>
v0.34 (ADR 0067): call edges whose caller is key — what it calls.
Sourcepub fn impls_of<'a>(
&'a self,
key: &SymbolKey,
) -> impl Iterator<Item = &'a ImplEdge>
pub fn impls_of<'a>( &'a self, key: &SymbolKey, ) -> impl Iterator<Item = &'a ImplEdge>
v0.35 (ADR 0068): impl edges whose capability is key — its providers.
Sourcepub fn equals_modulo_rename(
&self,
post: &ProjectIndex,
from: &SymbolKey,
to_name: &str,
remap: impl FnMut(&SiteRef) -> SiteRef,
) -> bool
pub fn equals_modulo_rename( &self, post: &ProjectIndex, from: &SymbolKey, to_name: &str, remap: impl FnMut(&SiteRef) -> SiteRef, ) -> bool
Structural equality after mapping self’s sites through remap
and renaming from to to_name — the rename capture/escape
validator. remap converts a pre-edit site to its post-edit
position (rename edits shift spans within edited files).
Trait Implementations§
Source§impl Clone for ProjectIndex
impl Clone for ProjectIndex
Source§fn clone(&self) -> ProjectIndex
fn clone(&self) -> ProjectIndex
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ProjectIndex
impl Debug for ProjectIndex
Source§impl Default for ProjectIndex
impl Default for ProjectIndex
Source§fn default() -> ProjectIndex
fn default() -> ProjectIndex
Auto Trait Implementations§
impl Freeze for ProjectIndex
impl RefUnwindSafe for ProjectIndex
impl Send for ProjectIndex
impl Sync for ProjectIndex
impl Unpin for ProjectIndex
impl UnsafeUnpin for ProjectIndex
impl UnwindSafe for ProjectIndex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);