Struct Analyzer 

pub struct Analyzer<Context> { /* private fields */ }

Represents a Workflow Description Language (WDL) document analyzer.

By default, analysis parses documents, performs validation checks, resolves imports, and performs type checking.

Each analysis operation is processed in order of request; however, the individual parsing, resolution, and analysis of documents is performed across a thread pool.

Note that dropping the analyzer is a blocking operation as it will wait for the queue thread to join.

The type parameter is the context type passed to the progress callback.

Implementations

impl<Context> Analyzer<Context>

where Context: Send + Clone + 'static,

pub fn new<Progress, Return>(config: Config, progress: Progress) -> Self

where Progress: Fn(Context, ProgressKind, usize, usize) -> Return + Send + 'static, Return: Future<Output = ()>,

Constructs a new analyzer with the given config.

The provided progress callback will be invoked during analysis.

The analyzer will use a default validator for validation.

The analyzer must be constructed from the context of a Tokio runtime.

pub fn new_with_resolution<Progress, Return>( config: Config, resolution: ResolutionContext, progress: Progress, ) -> Self

where Progress: Fn(Context, ProgressKind, usize, usize) -> Return + Send + 'static, Return: Future<Output = ()>,

Constructs a new analyzer with the given config and resolution context.

The provided progress callback will be invoked during analysis.

The analyzer will use a default validator for validation.

The analyzer must be constructed from the context of a Tokio runtime.

pub fn new_with_validator<Progress, Return, Validator>( config: Config, progress: Progress, validator: Validator, ) -> Self

where Progress: Fn(Context, ProgressKind, usize, usize) -> Return + Send + 'static, Return: Future<Output = ()>, Validator: Fn() -> Validator + Send + Sync + 'static,

Constructs a new analyzer with the given config and validator function.

The provided progress callback will be invoked during analysis.

This validator function will be called once per worker thread to initialize a thread-local validator.

The analyzer must be constructed from the context of a Tokio runtime.

pub fn new_with_validator_and_resolution<Progress, Return, Validator>( config: Config, resolution: ResolutionContext, progress: Progress, validator: Validator, ) -> Self

where Progress: Fn(Context, ProgressKind, usize, usize) -> Return + Send + 'static, Return: Future<Output = ()>, Validator: Fn() -> Validator + Send + Sync + 'static,

Constructs a new analyzer with the given config, resolution context, and validator function.

The provided progress callback will be invoked during analysis.

This validator function will be called once per worker thread to initialize a thread-local validator.

The analyzer must be constructed from the context of a Tokio runtime.

pub async fn swap_validator<Validator>( &self, validator: Validator, ) -> Result<()>

where Validator: Fn() -> Validator + Send + Sync + 'static,

Replace the current validator function.

This will mark all documents for re-analysis.

pub async fn add_document(&self, uri: Url) -> Result<()>

Adds a document to the analyzer. Document can be a local file or a URL.

Returns an error if the document could not be added.

pub async fn add_directory(&self, path: impl Into<PathBuf>) -> Result<()>

Adds a directory to the analyzer. It will recursively search for WDL documents in the supplied directory.

Returns an error if there was a problem discovering documents for the specified path.

pub async fn unroot_documents(&self, documents: Vec<Url>) -> Result<()>

Removes the specified documents from the analyzer.

If a specified URI is a prefix (i.e. directory) of documents known to the analyzer, those documents will be removed.

Documents are only removed when not referenced from importing documents. To forcefully delete the documents from the graph, use Self::delete_documents().

pub async fn delete_documents(&self, documents: Vec<Url>) -> Result<()>

Deletes the specified documents from the analyzer.

This differs from Self::unroot_documents(), as a deletion will occur even if the document(s) are referenced in other documents.

pub fn notify_incremental_change( &self, document: Url, change: IncrementalChange, ) -> Result<()>

Notifies the analyzer that a document has an incremental change.

Changes to documents that aren’t known to the analyzer are ignored.

pub fn notify_change(&self, document: Url, discard_pending: bool) -> Result<()>

Notifies the analyzer that a document has fully changed and should be fetched again.

Changes to documents that aren’t known to the analyzer are ignored.

If discard_pending is true, then any pending incremental changes are discarded; otherwise, the full change is ignored if there are pending incremental changes.

pub async fn analyze_document( &self, context: Context, document: Url, ) -> Result<Vec<AnalysisResult>>

Analyzes a specific document.

The provided context is passed to the progress callback.

If the document is up-to-date and was previously analyzed, the current analysis result is returned.

Returns an analysis result for each document that was analyzed.

pub async fn analyze(&self, context: Context) -> Result<Vec<AnalysisResult>>

Performs analysis of all documents.

The provided context is passed to the progress callback.

If a document is up-to-date and was previously analyzed, the current analysis result is returned.

Returns an analysis result for each document that was analyzed.

pub async fn call_hierarchy( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<Vec<CallHierarchyItem>>>

Get the call hierarchy for the symbol at the current position.

pub async fn format_document( &self, document: Url, ) -> Result<Option<(u32, u32, String)>>

Formats a document.

pub async fn folding_range( &self, document: Url, ) -> Result<Option<Vec<FoldingRange>>>

Get all folding ranges in a document.

pub async fn goto_definition( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<GotoDefinitionResponse>>

Performs a “goto definition” for a symbol at the current position.

pub async fn find_all_references( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, include_declaration: bool, ) -> Result<Vec<Location>>

Performs a find references for a symbol across all the documents.

pub async fn code_lens(&self, document: Url) -> Result<Option<Vec<CodeLens>>>

Get all code lenses in a document.

pub async fn completion( &self, context: Context, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<CompletionResponse>>

Performs a auto-completion for a symbol.

pub async fn hover( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<Hover>>

Performs a hover for a symbol at a given position in a document.

pub async fn rename( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, new_name: String, ) -> Result<Option<WorkspaceEdit>>

Renames a symbol at a given position across the workspace.

pub async fn semantic_tokens( &self, document: Url, ) -> Result<Option<SemanticTokensResult>>

Gets semantic tokens for a document

pub async fn document_symbol( &self, document: Url, ) -> Result<Option<DocumentSymbolResponse>>

Gets document symbols for a document.

pub async fn workspace_symbol( &self, query: String, ) -> Result<Option<Vec<SymbolInformation>>>

Gets document symbols for the workspace.

pub async fn incoming_calls( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<Vec<CallHierarchyIncomingCall>>>

Get the incoming calls for the symbol at the current position.

pub async fn outgoing_calls( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<Vec<CallHierarchyOutgoingCall>>>

Get the outgoing calls for the symbol at the current position.

pub async fn signature_help( &self, document: Url, position: SourcePosition, encoding: SourcePositionEncoding, ) -> Result<Option<SignatureHelp>>

Gets signature help for a function call at a given position.

pub async fn inlay_hints( &self, document: Url, range: Range, ) -> Result<Option<Vec<InlayHint>>>

Requests inlay hints for a document.

Trait Implementations

impl<Context> Debug for Analyzer<Context>

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

Formats the value using the given formatter.

impl Default for Analyzer<()>

fn default() -> Self

Returns the “default value” for a type.

impl<C> Drop for Analyzer<C>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.