Struct ruby_prism::ParseResult

pub struct ParseResult<'pr> { /* private fields */ }

The result of parsing a source string.

Implementations

impl<'pr> ParseResult<'pr>

pub const fn source(&self) -> &'pr [u8]

Returns the source string that was parsed.

pub fn frozen_string_literals(&self) -> bool

Returns whether we found a frozen_string_literal magic comment with a true value.

pub fn as_slice(&self, location: &Location<'pr>) -> &'pr [u8]

Returns a slice of the source string that was parsed using the given location range.

Panics

Panics if start offset or end offset are not valid offsets from the root.

pub fn errors(&self) -> Diagnostics<'_>

Returns an iterator that can be used to iterate over the errors in the parse result.

pub fn warnings(&self) -> Diagnostics<'_>

Returns an iterator that can be used to iterate over the warnings in the parse result.

pub fn comments(&self) -> Comments<'_>

Returns an iterator that can be used to iterate over the comments in the parse result.

pub fn data_loc(&self) -> Option<Location<'_>>

Returns an optional location of the END marker and the rest of the content of the file.

pub fn node(&self) -> Node<'_>

Returns the root node of the parse result.

Trait Implementations

impl<'pr> Debug for ParseResult<'pr>

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

Formats the value using the given formatter.

impl<'pr> Drop for ParseResult<'pr>

fn drop(&mut self)

Executes the destructor for this type.