Struct AnalysisHost

pub struct AnalysisHost<L: AnalysisLoader = CargoAnalysisLoader> { /* private fields */ }

Implementations

impl AnalysisHost<CargoAnalysisLoader>

pub fn new(target: Target) -> AnalysisHost

impl<L: AnalysisLoader> AnalysisHost<L>

pub fn new_with_loader(loader: L) -> Self

pub fn reload_from_analysis( &self, analysis: Vec<Analysis>, path_prefix: &Path, base_dir: &Path, blacklist: &[impl AsRef<str> + Debug], ) -> AResult<()>

Reloads given data passed in analysis. This will first check and read on-disk data (just like reload). It then imports the data we’re passing in directly.

pub fn reload(&self, path_prefix: &Path, base_dir: &Path) -> AResult<()>

pub fn reload_with_blacklist( &self, path_prefix: &Path, base_dir: &Path, blacklist: &[impl AsRef<str> + Debug], ) -> AResult<()>

pub fn hard_reload(&self, path_prefix: &Path, base_dir: &Path) -> AResult<()>

Reloads the entire project’s analysis data.

pub fn hard_reload_with_blacklist( &self, path_prefix: &Path, base_dir: &Path, blacklist: &[impl AsRef<str> + Debug], ) -> AResult<()>

pub fn has_def(&self, id: Id) -> bool

Note that self.has_def() =/> self.goto_def().is_ok(), since if the Def is in an api crate, there is no reasonable Span to jump to.

pub fn get_def(&self, id: Id) -> AResult<Def>

pub fn goto_def(&self, span: &Span) -> AResult<Span>

pub fn for_each_child_def<F, T>(&self, id: Id, f: F) -> AResult<Vec<T>>

where F: FnMut(Id, &Def) -> T,

pub fn def_parents(&self, id: Id) -> AResult<Vec<(Id, String)>>

pub fn def_roots(&self) -> AResult<Vec<(Id, String)>>

Returns the name of each crate in the program and the id of the root module of that crate.

pub fn id(&self, span: &Span) -> AResult<Id>

pub fn crate_local_id(&self, span: &Span) -> AResult<Id>

Like id, but will only return a value if it is in the same crate as span.

pub fn find_all_refs( &self, span: &Span, include_decl: bool, force_unique_spans: bool, ) -> AResult<Vec<Span>>

pub fn show_type(&self, span: &Span) -> AResult<String>

pub fn docs(&self, span: &Span) -> AResult<String>

pub fn matching_defs(&self, stem: &str) -> AResult<Vec<Def>>

Finds Defs with names that starting with (ignoring case) stem

pub fn query_defs(&self, query: SymbolQuery) -> AResult<Vec<Def>>

pub fn search(&self, name: &str) -> AResult<Vec<Span>>

Search for a symbol name, returns a list of spans matching defs and refs for that name.

pub fn find_all_refs_by_id(&self, id: Id) -> AResult<Vec<Span>>

pub fn find_impls(&self, id: Id) -> AResult<Vec<Span>>

pub fn search_for_id(&self, name: &str) -> AResult<Vec<Id>>

Search for a symbol name, returning a list of def_ids for that name.

pub fn symbols(&self, file_name: &Path) -> AResult<Vec<SymbolResult>>

pub fn doc_url(&self, span: &Span) -> AResult<String>

pub fn src_url(&self, span: &Span) -> AResult<String>