pub struct CachedBuild {Show 13 fields
pub nodes: HashMap<AbsPath, HashMap<NodeId, NodeInfo>>,
pub path_to_abs: HashMap<RelPath, AbsPath>,
pub external_refs: ExternalRefs,
pub id_to_path_map: HashMap<SolcFileId, String>,
pub decl_index: HashMap<NodeId, DeclNode>,
pub node_id_to_source_path: HashMap<NodeId, AbsPath>,
pub hint_index: HintIndex,
pub doc_index: DocIndex,
pub completion_cache: Arc<CompletionCache>,
pub build_version: i32,
pub content_hash: u64,
pub qualifier_refs: HashMap<NodeId, Vec<NodeId>>,
pub base_function_implementation: HashMap<NodeId, Vec<NodeId>>,
}Expand description
Pre-computed AST index. Built once when an AST enters the cache, then reused on every goto/references/rename/hover request.
All data from the raw solc JSON is consumed during new() into
pre-built indexes. The raw JSON is not retained.
Fields§
§nodes: HashMap<AbsPath, HashMap<NodeId, NodeInfo>>§path_to_abs: HashMap<RelPath, AbsPath>§external_refs: ExternalRefs§id_to_path_map: HashMap<SolcFileId, String>§decl_index: HashMap<NodeId, DeclNode>O(1) typed declaration node lookup by AST node ID. Built from the typed AST via visitor. Contains functions, variables, contracts, events, errors, structs, enums, modifiers, and UDVTs.
node_id_to_source_path: HashMap<NodeId, AbsPath>O(1) lookup from any declaration/source-unit node ID to its source file path.
Built from typed_ast during construction. Replaces the O(N)
find_source_path_for_node() that walked raw JSON.
hint_index: HintIndexPre-built hint lookup per file. Built once, reused on every inlay hint request (avoids O(n²) declaration resolution per request).
doc_index: DocIndexPre-built documentation index from solc userdoc/devdoc. Merged and keyed by selector for fast hover lookup.
completion_cache: Arc<CompletionCache>Pre-built completion cache. Built from sources during construction before the sources key is stripped.
build_version: i32The text_cache version this build was created from. Used to detect dirty files (unsaved edits since last build).
content_hash: u64FxHash of the source text this build was compiled from. Used to skip redundant rebuilds when content has not changed (e.g. format-on-save loops that re-trigger didSave with identical text).
qualifier_refs: HashMap<NodeId, Vec<NodeId>>Qualifier reference index: maps a container declaration ID
(contract/library/interface) to IdentifierPath node IDs that use
it as a qualifier prefix in qualified type paths (e.g., Pool.State).
Built at cache time by following referencedDeclaration on multi-segment
IdentifierPath nodes to their declaration, then reading the declaration’s
scope field to find the container.
base_function_implementation: HashMap<NodeId, Vec<NodeId>>Bidirectional implementation index built from baseFunctions/baseModifiers.
Maps each declaration ID to the set of IDs that are semantically
equivalent (interface ↔ implementation). For example, if
PoolManager.swap (616) has baseFunctions: [2036] (IPoolManager.swap),
this will contain 616 → [2036] and 2036 → [616].
Used by textDocument/implementation, textDocument/references, and
callHierarchy/incomingCalls to unify interface and implementation IDs.
Empty in warm-loaded builds (from_reference_index).
Implementations§
Source§impl CachedBuild
impl CachedBuild
Sourcepub fn new(
ast: Value,
build_version: i32,
interner: Option<&mut PathInterner>,
) -> Self
pub fn new( ast: Value, build_version: i32, interner: Option<&mut PathInterner>, ) -> Self
Build the index from normalized AST output.
Canonical shape:
sources[path] = { id, ast }contracts[path][name] = { evm, devdoc, ... }source_id_to_path = { "0": "path", ... }
When interner is provided, solc’s per-compilation file IDs in all
src strings are translated into canonical IDs from the project-wide
PathInterner. This ensures all CachedBuild instances share the
same file-ID space regardless of which solc invocation produced them.
Sourcepub fn merge_missing_from(&mut self, other: &CachedBuild)
pub fn merge_missing_from(&mut self, other: &CachedBuild)
Absorb data from a previous build for files this build doesn’t cover.
For each file in other.nodes that is not already present in
self.nodes, copies the node map, path mapping, and any related
entries. This ensures a freshly compiled project index never loses
coverage compared to the warm-loaded cache it replaces.
Sourcepub fn from_reference_index(
nodes: HashMap<AbsPath, HashMap<NodeId, NodeInfo>>,
path_to_abs: HashMap<RelPath, AbsPath>,
external_refs: ExternalRefs,
id_to_path_map: HashMap<SolcFileId, String>,
build_version: i32,
interner: Option<&mut PathInterner>,
) -> Self
pub fn from_reference_index( nodes: HashMap<AbsPath, HashMap<NodeId, NodeInfo>>, path_to_abs: HashMap<RelPath, AbsPath>, external_refs: ExternalRefs, id_to_path_map: HashMap<SolcFileId, String>, build_version: i32, interner: Option<&mut PathInterner>, ) -> Self
Construct a minimal cached build from persisted reference/goto indexes.
This is used for fast startup warm-cache restores where we only need cross-file node/reference maps (not full gas/doc/hint indexes).
When interner is provided, the id_to_path_map entries are
registered in the interner so that subsequent compilations will
assign the same canonical IDs to the same paths.
Trait Implementations§
Source§impl Clone for CachedBuild
impl Clone for CachedBuild
Source§fn clone(&self) -> CachedBuild
fn clone(&self) -> CachedBuild
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CachedBuild
impl RefUnwindSafe for CachedBuild
impl Send for CachedBuild
impl Sync for CachedBuild
impl Unpin for CachedBuild
impl UnsafeUnpin for CachedBuild
impl UnwindSafe for CachedBuild
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,
Source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§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();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§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();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§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();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§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();Source§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.Source§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);