Struct Document

pub struct Document { /* private fields */ }

Represents an analyzed WDL document.

This type is cheaply cloned.

Implementations

impl Document

pub fn config(&self) -> &Config

Gets the analysis configuration.

pub fn root(&self) -> Document

Gets the root AST document node.

Panics

Panics if the document was not parsed.

pub fn id(&self) -> &Arc<String>

Gets the identifier of the document.

This value changes when a document is reanalyzed.

pub fn uri(&self) -> &Arc<Url>

Gets the URI of the document.

pub fn path(&self) -> Cow<'_, str>

Gets the path to the document.

If the scheme of the document’s URI is not file, this will return the URI as a string. Otherwise, this will attempt to return the path relative to the current working directory, or the absolute path failing that.

pub fn version(&self) -> Option<SupportedVersion>

Gets the supported version of the document.

Returns None if the document could not be parsed or contains an unsupported version.

pub fn namespaces(&self) -> impl Iterator<Item = (&str, &Namespace)>

Gets the namespaces in the document.

pub fn namespace(&self, name: &str) -> Option<&Namespace>

Gets a namespace in the document by name.

pub fn tasks(&self) -> impl Iterator<Item = &Task>

Gets the tasks in the document.

pub fn task_by_name(&self, name: &str) -> Option<&Task>

Gets a task in the document by name.

pub fn workflow(&self) -> Option<&Workflow>

Gets a workflow in the document.

Returns None if the document did not contain a workflow.

pub fn structs(&self) -> impl Iterator<Item = (&str, &Struct)>

Gets the structs in the document.

pub fn struct_by_name(&self, name: &str) -> Option<&Struct>

Gets a struct in the document by name.

pub fn diagnostics(&self) -> &[Diagnostic]

Gets the analysis diagnostics for the document.

pub fn sort_diagnostics(&mut self) -> Self

Sorts the diagnostics for the document.

Panics

Panics if there is more than one reference to the document.

pub fn extend_diagnostics(&mut self, diagnostics: Vec<Diagnostic>) -> Self

Extends the diagnostics for the document.

Panics

Panics if there is more than one reference to the document.

pub fn find_scope_by_position(&self, position: usize) -> Option<ScopeRef<'_>>

Finds a scope based on a position within the document.

pub fn has_errors(&self) -> bool

Determines if the document, or any documents transitively imported by this document, has errors.

Returns true if the document, or one of its transitive imports, has at least one error diagnostic.

Returns false if the document, and all of its transitive imports, have no error diagnostics.

pub fn visit<V: Visitor>(&self, diagnostics: &mut Diagnostics, visitor: &mut V)

Visits the document with a pre-order traversal using the provided visitor to visit each element in the document.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.