Struct Parser

pub struct Parser<'a> { /* private fields */ }

Parser for the rune language.

Examples

use rune::ast;
use rune::SourceId;
use rune::parse::Parser;

let mut parser = Parser::new("fn foo() {}", SourceId::empty(), false);
let ast = parser.parse::<ast::ItemFn>()?;

Implementations

impl<'a> Parser<'a>

pub fn new(source: &'a str, source_id: SourceId, shebang: bool) -> Self

Construct a new parser around the given source.

shebang indicates if the parser should try and parse a shebang or not.

pub fn from_token_stream(token_stream: &'a TokenStream, span: Span) -> Self

Construct a parser from a token stream. The second argument span is the span to use if the stream is empty.

pub fn parse<T>(&mut self) -> Result<T>

where T: Parse,

Parse a specific item from the parser.

pub fn parse_all<T>(&mut self) -> Result<T>

where T: Parse,

Parse a specific item from the parser and then expect end of input.

pub fn peek<T>(&mut self) -> Result<bool>

where T: Peek,

Peek for the given token.

pub fn eof(&mut self) -> Result<()>

Assert that the parser has reached its end-of-file.

pub fn is_eof(&mut self) -> Result<bool>

Test if the parser is at end-of-file, after which there is no more input to parse.

pub fn try_consume<T>(&mut self) -> Result<bool>

where T: Parse + Peek,

Try to consume a single thing matching T, returns true if any tokens were consumed.

pub fn try_consume_all<T>(&mut self) -> Result<bool>

where T: Parse + Peek,

Try to consume all things matching T, returns true if any tokens were consumed.

Trait Implementations

impl<'a> Debug for Parser<'a>

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

Formats the value using the given formatter.