Struct ra_ap_ide::Analysis

pub struct Analysis { /* private fields */ }

Analysis is a snapshot of a world state at a moment in time. It is the main entry point for asking semantic information about the world. When the world state is advanced using AnalysisHost::apply_change method, all existing Analysis are canceled (most method return Err(Canceled)).

Implementations

impl Analysis

pub fn from_single_file(text: String) -> (Analysis, FileId)

pub fn status(&self, file_id: Option<FileId>) -> Cancellable<String>

Debug info about the current state of the analysis.

pub fn prime_caches<F>(&self, cb: F) -> Cancellable<()> where
    F: Fn(PrimeCachesProgress) + Sync + UnwindSafe, 

pub fn file_text(&self, file_id: FileId) -> Cancellable<Arc<String>>

Gets the text of the source file.

pub fn parse(&self, file_id: FileId) -> Cancellable<SourceFile>

Gets the syntax tree of the file.

pub fn is_library_file(&self, file_id: FileId) -> Cancellable<bool>

Returns true if this file belongs to an immutable library.

pub fn file_line_index(&self, file_id: FileId) -> Cancellable<Arc<LineIndex>>

Gets the file’s LineIndex: data structure to convert between absolute offsets and line/column representation.

pub fn extend_selection(&self, frange: FileRange) -> Cancellable<TextRange>

Selects the next syntactic nodes encompassing the range.

pub fn matching_brace(
    &self,
    position: FilePosition
) -> Cancellable<Option<TextSize>>

Returns position of the matching brace (all types of braces are supported).

pub fn syntax_tree(
    &self,
    file_id: FileId,
    text_range: Option<TextRange>
) -> Cancellable<String>

Returns a syntax tree represented as String, for debug purposes.

pub fn view_hir(&self, position: FilePosition) -> Cancellable<String>

pub fn view_item_tree(&self, file_id: FileId) -> Cancellable<String>

pub fn view_crate_graph(
    &self,
    full: bool
) -> Cancellable<Result<String, String>>

Renders the crate graph to GraphViz “dot” syntax.

pub fn expand_macro(
    &self,
    position: FilePosition
) -> Cancellable<Option<ExpandedMacro>>

pub fn join_lines(
    &self,
    config: &JoinLinesConfig,
    frange: FileRange
) -> Cancellable<TextEdit>

Returns an edit to remove all newlines in the range, cleaning up minor stuff like trailing commas.

pub fn on_enter(&self, position: FilePosition) -> Cancellable<Option<TextEdit>>

Returns an edit which should be applied when opening a new line, fixing up minor stuff like continuing the comment. The edit will be a snippet (with $0).

pub fn on_char_typed(
    &self,
    position: FilePosition,
    char_typed: char
) -> Cancellable<Option<SourceChange>>

Returns an edit which should be applied after a character was typed.

This is useful for some on-the-fly fixups, like adding ; to let = automatically.

pub fn file_structure(&self, file_id: FileId) -> Cancellable<Vec<StructureNode>>

Returns a tree representation of symbols in the file. Useful to draw a file outline.

pub fn inlay_hints(
    &self,
    config: &InlayHintsConfig,
    file_id: FileId
) -> Cancellable<Vec<InlayHint>>

Returns a list of the places in the file where type hints can be displayed.

pub fn folding_ranges(&self, file_id: FileId) -> Cancellable<Vec<Fold>>

Returns the set of folding ranges.

pub fn symbol_search(&self, query: Query) -> Cancellable<Vec<NavigationTarget>>

Fuzzy searches for a symbol.

pub fn goto_definition(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>>

Returns the definitions from the symbol at position.

pub fn goto_declaration(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>>

Returns the declaration from the symbol at position.

pub fn goto_implementation(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>>

Returns the impls from the symbol at position.

pub fn goto_type_definition(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>>

Returns the type definitions for the symbol at position.

pub fn find_all_refs(
    &self,
    position: FilePosition,
    search_scope: Option<SearchScope>
) -> Cancellable<Option<Vec<ReferenceSearchResult>>>

Finds all usages of the reference at point.

pub fn find_all_methods(&self, file_id: FileId) -> Cancellable<Vec<FileRange>>

Finds all methods and free functions for the file. Does not return tests!

pub fn hover(
    &self,
    config: &HoverConfig,
    range: FileRange
) -> Cancellable<Option<RangeInfo<HoverResult>>>

Returns a short text describing element at position.

pub fn moniker(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<MonikerResult>>>>

Returns moniker of symbol at position.

pub fn external_docs(
    &self,
    position: FilePosition
) -> Cancellable<Option<String>>

Return URL(s) for the documentation of the symbol under the cursor.

pub fn call_info(&self, position: FilePosition) -> Cancellable<Option<CallInfo>>

Computes parameter information for the given call expression.

pub fn call_hierarchy(
    &self,
    position: FilePosition
) -> Cancellable<Option<RangeInfo<Vec<NavigationTarget>>>>

Computes call hierarchy candidates for the given file position.

pub fn incoming_calls(
    &self,
    position: FilePosition
) -> Cancellable<Option<Vec<CallItem>>>

Computes incoming calls for the given file position.

pub fn outgoing_calls(
    &self,
    position: FilePosition
) -> Cancellable<Option<Vec<CallItem>>>

Computes outgoing calls for the given file position.

pub fn parent_module(
    &self,
    position: FilePosition
) -> Cancellable<Vec<NavigationTarget>>

Returns a mod name; declaration which created the current module.

pub fn crate_for(&self, file_id: FileId) -> Cancellable<Vec<CrateId>>

Returns crates this file belongs too.

pub fn crate_edition(&self, crate_id: CrateId) -> Cancellable<Edition>

Returns the edition of the given crate.

pub fn crate_root(&self, crate_id: CrateId) -> Cancellable<FileId>

Returns the root file of the given crate.

pub fn runnables(&self, file_id: FileId) -> Cancellable<Vec<Runnable>>

Returns the set of possible targets to run for the current file.

pub fn related_tests(
    &self,
    position: FilePosition,
    search_scope: Option<SearchScope>
) -> Cancellable<Vec<Runnable>>

Returns the set of tests for the given file position.

pub fn highlight(&self, file_id: FileId) -> Cancellable<Vec<HlRange>>

Computes syntax highlighting for the given file

pub fn highlight_related(
    &self,
    config: HighlightRelatedConfig,
    position: FilePosition
) -> Cancellable<Option<Vec<HighlightedRange>>>

Computes all ranges to highlight for a given item in a file.

pub fn highlight_range(&self, frange: FileRange) -> Cancellable<Vec<HlRange>>

Computes syntax highlighting for the given file range.

pub fn highlight_as_html(
    &self,
    file_id: FileId,
    rainbow: bool
) -> Cancellable<String>

Computes syntax highlighting for the given file.

pub fn completions(
    &self,
    config: &CompletionConfig,
    position: FilePosition
) -> Cancellable<Option<Vec<CompletionItem>>>

Computes completions at the given position.

pub fn resolve_completion_edits(
    &self,
    config: &CompletionConfig,
    position: FilePosition,
    imports: impl IntoIterator<Item = (String, String)> + UnwindSafe
) -> Cancellable<Vec<TextEdit>>

Resolves additional completion data at the position given.

pub fn diagnostics(
    &self,
    config: &DiagnosticsConfig,
    resolve: AssistResolveStrategy,
    file_id: FileId
) -> Cancellable<Vec<Diagnostic>>

Computes the set of diagnostics for the given file.

pub fn assists_with_fixes(
    &self,
    assist_config: &AssistConfig,
    diagnostics_config: &DiagnosticsConfig,
    resolve: AssistResolveStrategy,
    frange: FileRange
) -> Cancellable<Vec<Assist>>

Convenience function to return assists + quick fixes for diagnostics

pub fn rename(
    &self,
    position: FilePosition,
    new_name: &str
) -> Cancellable<Result<SourceChange, RenameError>>

Returns the edit required to rename reference at the position to the new name.

pub fn prepare_rename(
    &self,
    position: FilePosition
) -> Cancellable<Result<RangeInfo<()>, RenameError>>

pub fn will_rename_file(
    &self,
    file_id: FileId,
    new_name_stem: &str
) -> Cancellable<Option<SourceChange>>

pub fn structural_search_replace(
    &self,
    query: &str,
    parse_only: bool,
    resolve_context: FilePosition,
    selections: Vec<FileRange>
) -> Cancellable<Result<SourceChange, SsrError>>

pub fn annotations(
    &self,
    config: &AnnotationConfig,
    file_id: FileId
) -> Cancellable<Vec<Annotation>>

pub fn resolve_annotation(
    &self,
    annotation: Annotation
) -> Cancellable<Annotation>

pub fn move_item(
    &self,
    range: FileRange,
    direction: Direction
) -> Cancellable<Option<TextEdit>>

Trait Implementations

impl Debug for Analysis

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.