Struct wdl_analysis::AnalysisEngine

pub struct AnalysisEngine { /* private fields */ }

Represents a Workflow Description Language (WDL) analysis engine.

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.

Implementations

impl AnalysisEngine

pub fn new() -> Result<Self>

Creates a new analysis engine using a default validator.

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

pub fn new_with_validator<V>(validator: V) -> Result<Self>

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

Creates a new analysis engine with the given function that produces a validator to use.

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

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

pub async fn analyze(&self, path: &Path) -> Vec<AnalysisResult>

Analyzes the given file system path.

If the path is a directory, the directory will be recursively searched for files with a .wdl extension to analyze.

Otherwise, a single file is analyzed.

pub async fn analyze_with_progress<F>( &self, path: &Path, progress: F, ) -> Vec<AnalysisResult>

where F: Fn(ProgressKind, usize, usize) + Send + Sync + 'static,

Analyzes the given file system path and reports progress to the given callback.

If the path is a directory, the directory will be recursively searched for files with a .wdl extension to analyze.

Otherwise, a single file is analyzed.

Progress is reported to the provided callback function with a minimum 50ms interval.

pub fn result(&self, path: &Path) -> Option<AnalysisResult>

Gets a previous analysis result for a file.

Returns None if the file has not been analyzed yet.

pub async fn shutdown(self)

Shuts down the engine and waits for outstanding requests to complete.

Trait Implementations

impl Debug for AnalysisEngine

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

Formats the value using the given formatter.