Struct Analysis

pub struct Analysis {

    pub position_encoding: PositionEncoding,
    pub allow_overlapping_token: bool,
    pub allow_multiline_token: bool,
    pub remove_html: bool,
    pub extended_code_action: bool,
    pub completion_feat: CompletionFeat,
    pub color_theme: ColorTheme,
    pub lint: TaskWhen,
    pub periscope: Option<Arc<dyn PeriscopeProvider + Send + Sync>>,
    pub workers: Arc<AnalysisGlobalWorkers>,
    pub tokens_caches: Arc<Mutex<SemanticTokenCache>>,
    pub caches: AnalysisGlobalCaches,
    pub analysis_rev_cache: Arc<Mutex<AnalysisRevCache>>,
    pub stats: Arc<AnalysisStats>,
}

The analysis data holds globally.

Fields

position_encoding: PositionEncoding

The position encoding for the workspace.

allow_overlapping_token: bool

Whether to allow overlapping semantic tokens.

allow_multiline_token: bool

Whether to allow multiline semantic tokens.

remove_html: bool

Whether to remove html from markup content in responses.

extended_code_action: bool

Whether to utilize the extended tinymist.resolveCodeAction at client side.

The extended feature by tinymist.resolveCodeAction:

• supports Snippet edit.

The example implementation can be found in the VS Code extension.

completion_feat: CompletionFeat

Tinymist’s completion features.

color_theme: ColorTheme

The editor’s color theme.

lint: TaskWhen

When to trigger the lint.

periscope: Option<Arc<dyn PeriscopeProvider + Send + Sync>>

The periscope provider.

workers: Arc<AnalysisGlobalWorkers>

The global worker resources for analysis.

tokens_caches: Arc<Mutex<SemanticTokenCache>>

The semantic token cache.

caches: AnalysisGlobalCaches

The global caches for analysis.

analysis_rev_cache: Arc<Mutex<AnalysisRevCache>>

The revision-managed cache for analysis.

stats: Arc<AnalysisStats>

The statistics about the analyzers.

Implementations

impl Analysis

pub fn enter(&self, world: LspWorld) -> LocalContextGuard

Enters the analysis context.

pub fn query_snapshot( self: Arc<Self>, snap: LspComputeGraph, req: Option<&CompilerQueryRequest>, ) -> LspQuerySnapshot

Gets a snapshot for language queries.

pub fn lock_revision( &self, req: Option<&CompilerQueryRequest>, ) -> AnalysisRevLock

Locks the revision in main thread.

pub fn clear_cache(&self)

Clear all cached resources.

pub fn report_query_stats(&self) -> String

Report the statistics of the analysis.

pub fn report_alloc_stats(&self) -> String

Report the statistics of the allocation.

pub fn trigger_suggest(&self, context: bool) -> Option<Interned<str>>

Get configured trigger suggest command.

pub fn trigger_parameter_hints(&self, context: bool) -> Option<Interned<str>>

Get configured trigger parameter hints command.

pub fn trigger_on_snippet(&self, context: bool) -> Option<Interned<str>>

Get configured trigger suggest after snippet command.

VS Code doesn’t do that… Auto triggering suggestion only happens on typing (word starts or trigger characters). However, you can use editor.action.triggerSuggest as command on a suggestion to “manually” retrigger suggest after inserting one

pub fn trigger_on_snippet_with_param_hint( &self, context: bool, ) -> Option<Interned<str>>

Get configured trigger on positional parameter hints command.

Trait Implementations

impl Clone for Analysis

fn clone(&self) -> Analysis

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Analysis

fn default() -> Analysis

Returns the “default value” for a type.