Struct Document 

pub struct Document<N: TreeNode = SyntaxNode>(/* private fields */);

Represents a single WDL document.

See Document::ast for getting a version-specific Abstract Syntax Tree.

Implementations

impl Document

pub fn parse(source: &str) -> (Self, Vec<Diagnostic>)

Parses a document from the given source.

A document and its AST elements are trivially cloned.

Example

let (document, diagnostics) = Document::parse("version 1.1");
assert!(diagnostics.is_empty());

assert_eq!(
    document
        .version_statement()
        .expect("should have version statement")
        .version()
        .text(),
    "1.1"
);

match document.ast() {
    Ast::V1(ast) => {
        assert_eq!(ast.items().count(), 0);
    }
    Ast::Unsupported => panic!("should be a V1 AST"),
}

impl<N: TreeNode> Document<N>

pub fn version_statement(&self) -> Option<VersionStatement<N>>

Gets the version statement of the document.

This can be used to determine the version of the document that was parsed.

A return value of None signifies a missing version statement.

pub fn ast(&self) -> Ast<N>

Gets the AST representation of the document.

pub fn ast_with_version_fallback( &self, fallback_version: Option<SupportedVersion>, ) -> Ast<N>

Gets the AST representation of the document, falling back to the specified WDL version if the document’s version statement contains an unrecognized version.

A fallback version of None does not have any fallback behavior, and is equivalent to calling Document::ast().

It is the caller’s responsibility to ensure that falling back to the given version does not introduce unwanted behavior. For applications where correctness is essential, the caller should only provide a version that is known to be compatible with the version declared in the document.

pub fn morph<U: TreeNode + NewRoot<N>>(self) -> Document<U>

Morphs a document of one node type to a document of a different node type.

Trait Implementations

impl<N: TreeNode> AstNode<N> for Document<N>

fn can_cast(kind: SyntaxKind) -> bool

Determines if the kind can be cast to this representation.

fn cast(inner: N) -> Option<Self>

Casts the given inner type to the this representation.

fn inner(&self) -> &N

Gets the inner type from this representation.

fn kind(&self) -> SyntaxKind

Gets the syntax kind of the node.

fn text<'a>(&'a self) -> impl Display

where N: 'a,

Gets the text of the node.

fn span(&self) -> Span

Gets the span of the node.

fn token<C>(&self) -> Option<C>

where C: AstToken<N::Token>,

Gets the first token child that can cast to an expected type.

fn tokens<'a, C>(&'a self) -> impl Iterator<Item = C>

where C: AstToken<N::Token>, N: 'a,

Gets all the token children that can cast to an expected type.

fn last_token<C>(&self) -> Option<C>

where C: AstToken<N::Token>,

Gets the last token of the node and attempts to cast it to an expected type.

fn child<C>(&self) -> Option<C>

where C: AstNode<N>,

Gets the first node child that can cast to an expected type.

fn children<'a, C>(&'a self) -> impl Iterator<Item = C>

where C: AstNode<N>, N: 'a,

Gets all node children that can cast to an expected type.

fn parent<'a, P>(&self) -> Option<P>

where P: AstNode<N>, N: 'a,

Gets the parent of the node if the underlying tree node has a parent.

fn scope_span<O, C>(&self) -> Option<Span>

where O: AstToken<N::Token>, C: AstToken<N::Token>,

Calculates the span of a scope given the node where the scope is visible.

fn braced_scope_span(&self) -> Option<Span>

Gets the interior span of child opening and closing brace tokens for the node.

fn heredoc_scope_span(&self) -> Option<Span>

Gets the interior span of child opening and closing heredoc tokens for the node.

fn descendants<'a, D>(&'a self) -> impl Iterator<Item = D>

where D: AstNode<N>, N: 'a,

Gets the node descendants (including self) from this node that can be cast to the expected type.

impl<N: Clone + TreeNode> Clone for Document<N>

fn clone(&self) -> Document<N>

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.

impl<N: Hash + TreeNode> Hash for Document<N>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N: PartialEq + TreeNode> PartialEq for Document<N>

fn eq(&self, other: &Document<N>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<N: Eq + TreeNode> Eq for Document<N>

impl<N: TreeNode> StructuralPartialEq for Document<N>