Struct Validator 

pub struct Validator { /* private fields */ }

Implements an AST validator.

A validator operates on a set of AST visitors.

See the validate method to perform the validation.

Implementations

impl Validator

pub fn empty() -> Self

Creates a validator with an empty visitors set.

pub fn add_visitor<V: Visitor + 'static>(&mut self, visitor: V)

Adds a visitor to the validator.

pub fn add_visitors( &mut self, visitors: impl IntoIterator<Item = Box<dyn Visitor>>, )

Adds multiple visitors to the validator.

pub fn extend_known_rules(&mut self, rules: impl IntoIterator<Item = String>)

Adds rule names to the validator’s known rules set.

pub fn validate( &mut self, document: &Document, config: &Config, ) -> Result<(), Diagnostics>

Validates the given document and returns the validation errors upon failure.

pub fn find_nearest_rule(&self, unknown_rule_id: &str) -> Option<String>

Finds the nearest known rule ID to the given unknown rule ID, or None if no rule ID is close enough.

Trait Implementations

impl Default for Validator

fn default() -> Self

Creates a validator with the default validation visitors.

impl Visitor for Validator

fn known_rules(&self) -> HashSet<String>

Get all lint rules known to this Visitor.

fn register(&mut self, config: &Config)

Registers configuration with a visitor.

fn reset(&mut self)

Resets the visitor to its initial state.

fn document( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, doc: &Document, version: SupportedVersion, )

Visits the root document node.

fn whitespace(&mut self, diagnostics: &mut Diagnostics, whitespace: &Whitespace)

Visits a whitespace token.

fn comment(&mut self, diagnostics: &mut Diagnostics, comment: &Comment)

Visit a comment token.

fn version_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &VersionStatement, )

Visits a top-level version statement node.

fn import_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ImportStatement, )

Visits a top-level import statement node.

fn struct_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, def: &StructDefinition, )

Visits a struct definition node.

fn enum_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, def: &EnumDefinition, )

Visits an enum definition node.

fn task_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, task: &TaskDefinition, )

Visits a task definition node.

fn workflow_definition( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, workflow: &WorkflowDefinition, )

Visits a workflow definition node.

fn input_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &InputSection, )

Visits an input section node.

fn output_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &OutputSection, )

Visits an output section node.

fn command_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &CommandSection, )

Visits a command section node.

fn command_text(&mut self, diagnostics: &mut Diagnostics, text: &CommandText)

Visits a command text token in a command section node.

fn requirements_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &RequirementsSection, )

Visits a requirements section node.

fn task_hints_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &TaskHintsSection, )

Visits a task hints section node.

fn workflow_hints_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &WorkflowHintsSection, )

Visits a workflow hints section node.

fn runtime_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &RuntimeSection, )

Visits a runtime section node.

fn runtime_item( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &RuntimeItem, )

Visits a runtime item node.

fn metadata_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &MetadataSection, )

Visits a metadata section node.

fn parameter_metadata_section( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, section: &ParameterMetadataSection, )

Visits a parameter metadata section node.

fn metadata_object( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, object: &MetadataObject, )

Visits a metadata object in a metadata or parameter metadata section.

fn metadata_object_item( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &MetadataObjectItem, )

Visits a metadata object item in a metadata object.

fn metadata_array( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, item: &MetadataArray, )

Visits a metadata array node in a metadata or parameter metadata section.

fn unbound_decl( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, decl: &UnboundDecl, )

Visits an unbound declaration node.

fn bound_decl( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, decl: &BoundDecl, )

Visits a bound declaration node.

fn expr( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, expr: &Expr, )

Visits an expression node.

fn string_text(&mut self, diagnostics: &mut Diagnostics, text: &StringText)

Visits a string text token in a literal string node.

fn placeholder( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, placeholder: &Placeholder, )

Visits a placeholder node.

fn conditional_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ConditionalStatement, )

Visits a conditional statement node in a workflow.

fn scatter_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &ScatterStatement, )

Visits a scatter statement node in a workflow.

fn call_statement( &mut self, diagnostics: &mut Diagnostics, reason: VisitReason, stmt: &CallStatement, )

Visits a call statement node in a workflow.