Skip to main content

ParseResult

Struct ParseResult 

Source
pub struct ParseResult { /* private fields */ }
Expand description

Successful document parse output: the AST plus the buffers it borrows from, plus any non-fatal warnings the parser collected.

Modelled on chumsky’s ParseResult: the presence of the output and the presence of warnings are orthogonal, so both are returned side-by-side rather than encoded into Result. #[must_use] so warnings don’t get silently dropped.

Implementations§

Source§

impl ParseResult

Source

pub fn document(&self) -> &Document<'_>

Borrow the document AST.

Source

pub fn source(&self) -> &str

Borrow the preprocessed source the AST was parsed from.

Note: this is the text as seen by the grammar, after include resolution and other preprocessor transforms — not the original caller input.

Source

pub fn warnings(&self) -> &[Warning]

Borrow the collected warnings.

Source

pub fn take_warnings(&mut self) -> Vec<Warning>

Take the warnings out of this result, leaving an empty warnings slice behind. Useful when the caller wants to route warnings independently of the AST (e.g. attach them to an LSP diagnostic stream while keeping the document for further borrowing). The ParseResult keeps its AST intact — only warnings() becomes empty.

Trait Implementations§

Source§

impl Debug for ParseResult

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more