Struct rune::parse::Parser

source ·
pub struct Parser<'a> { /* private fields */ }
Expand description

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§

source§

impl<'a> Parser<'a>

source

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.

source

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.

source

pub fn parse<T>(&mut self) -> Result<T>
where T: Parse,

Parse a specific item from the parser.

source

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.

source

pub fn peek<T>(&mut self) -> Result<bool>
where T: Peek,

Peek for the given token.

source

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

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

source

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.

source

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.

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Parser<'a>

§

impl<'a> Send for Parser<'a>

§

impl<'a> Sync for Parser<'a>

§

impl<'a> Unpin for Parser<'a>

§

impl<'a> !UnwindSafe for Parser<'a>

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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