Struct Parse 

pub struct Parse<T> { /* private fields */ }

The result of a parse operation.

Returns the syntax tree even if there are parse errors. Use errors() or positioned_errors() to check for errors if needed. This allows for error-resilient tooling that can work with partial or invalid input.

Implementations

impl<T> Parse<T>

pub fn tree(&self) -> T

where T: AstNode<Language = Lang>,

The parse tree. If there were no parse errors, this is a valid tree. If there were parse errors, this tree might be only partially valid.

pub fn positioned_errors(&self) -> &[PositionedParseError]

Positioned parse errors with location information.

pub fn errors(&self) -> Vec<String>

Parse error messages, if any.

pub fn to_result(self) -> Result<T, YamlError>

where T: AstNode<Language = Lang>,

Convert parse result to a Result, failing with the first error if any.

The returned YamlError::Parse contains the error message but no line/column information because Parse does not retain the source text. Use YamlFile::from_str (which calls byte_offset_to_line_column internally) if you need precise positions in error messages.

pub fn has_errors(&self) -> bool

Whether the parse had any errors.

pub fn ok(&self) -> bool

Whether the parse succeeded without any errors.

impl Parse<YamlFile>

pub fn parse_yaml(text: &str) -> Self

Parse YAML text, returning a Parse result

Trait Implementations

impl<T: Clone> Clone for Parse<T>

fn clone(&self) -> Parse<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Parse<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Parse<T>

impl<T: PartialEq> PartialEq for Parse<T>

fn eq(&self, other: &Parse<T>) -> 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<T> StructuralPartialEq for Parse<T>