Trait Parse

Source

pub trait Parse<'a>: Sized {
    // Required method
    fn parse(parser: Parser<'a>) -> Result<Self>;
}

Expand description

A trait for parsing a fragment of syntax in a recursive descent fashion.

The Parse trait is main abstraction you’ll be working with when defining custom parser or custom syntax for your WebAssembly text format (or when using the official format items). Almost all items in the core module implement the Parse trait, and you’ll commonly use this with:

The top-level parse function to parse an entire input.
The intermediate Parser::parse function to parse an item out of an input stream and then parse remaining items.

Implementation of Parse take a Parser as input and will mutate the parser as they parse syntax. Once a token is consume it cannot be “un-consumed”. Utilities such as Parser::peek and Parser::lookahead1 can be used to determine what to parse next.

§When to parse `(` and `)`?

Conventionally types are not responsible for parsing their own ( and ) tokens which surround the type. For example WebAssembly imports look like:

(import "foo" "bar" (func (type 0)))

but the Import type parser looks like:

impl<'a> Parse<'a> for Import<'a> {
    fn parse(parser: Parser<'a>) -> Result<Self> {
        parser.parse::<kw::import>()?;
        // ...
    }
}

It is assumed here that the ( and ) tokens which surround an import statement in the WebAssembly text format are parsed by the parent item parsing Import.

Note that this is just a convention, so it’s not necessarily required for all types. It’s recommended that your types stick to this convention where possible to avoid nested calls to Parser::parens or accidentally trying to parse too many parenthesis.

§Examples

Let’s say you want to define your own WebAssembly text format which only contains imports and functions. You also require all imports to be listed before all functions. An example Parse implementation might look like:

use inf_wast::core::{Import, Func};
use inf_wast::kw;
use inf_wast::parser::{Parser, Parse, Result};

// Fields of a WebAssembly which only allow imports and functions, and all
// imports must come before all the functions
struct OnlyImportsAndFunctions<'a> {
    imports: Vec<Import<'a>>,
    functions: Vec<Func<'a>>,
}

impl<'a> Parse<'a> for OnlyImportsAndFunctions<'a> {
    fn parse(parser: Parser<'a>) -> Result<Self> {
        // While the second token is `import` (the first is `(`, so we care
        // about the second) we parse an `ast::ModuleImport` inside of
        // parentheses. The `parens` function here ensures that what we
        // parse inside of it is surrounded by `(` and `)`.
        let mut imports = Vec::new();
        while parser.peek2::<kw::import>()? {
            let import = parser.parens(|p| p.parse())?;
            imports.push(import);
        }

        // Afterwards we assume everything else is a function. Note that
        // `parse` here is a generic function and type inference figures out
        // that we're parsing functions here and imports above.
        let mut functions = Vec::new();
        while !parser.is_empty() {
            let func = parser.parens(|p| p.parse())?;
            functions.push(func);
        }

        Ok(OnlyImportsAndFunctions { imports, functions })
    }
}

Required Methods§

Source

fn parse(parser: Parser<'a>) -> Result<Self>

Attempts to parse Self from parser, returning an error if it could not be parsed.

This method will mutate the state of parser after attempting to parse an instance of Self. If an error happens then it is likely fatal and there is no guarantee of how many tokens have been consumed from parser.

As recommended in the documentation of Parse, implementations of this function should not start out by parsing ( and ) tokens, but rather parents calling recursive parsers should parse the ( and ) tokens for their child item that’s being parsed.

§Errors

This function will return an error if Self could not be parsed. Note that creating an Error is not exactly a cheap operation, so Error is typically fatal and propagated all the way back to the top parse call site.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait Parse Copy item path

§When to parse ( and )?

§Examples

Required Methods§

fn parse(parser: Parser<'a>) -> Result<Self>

§Errors

Dyn Compatibility§

Implementations on Foreign Types§

impl Parse<'_> for String

fn parse(parser: Parser<'_>) -> Result<Self>

impl<'a> Parse<'a> for &'a str

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for &'a [u8]

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (i8, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (i16, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (i32, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (i64, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (u8, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (u16, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (u32, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for (u64, Span)

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Option<NameAnnotation<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for i8

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for i16

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for i32

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for i64

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for u8

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for u16

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for u32

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for u64

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<CanonOpt<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<ComponentTypeDecl<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<InstanceTypeDecl<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<ModuleTypeDecl<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<ComponentExport<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<CoreInstanceExport<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<CoreInstantiationArg<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a> Parse<'a> for Vec<InstantiationArg<'a>>

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a, T> Parse<'a> for Box<T>where T: Parse<'a>,

fn parse(parser: Parser<'a>) -> Result<Self>

impl<'a, T: Peek + Parse<'a>> Parse<'a> for Option<T>

fn parse(parser: Parser<'a>) -> Result<Option<T>>

Implementors§

impl<'a> Parse<'a> for CanonOpt<'a>

impl<'a> Parse<'a> for ComponentExportAliasKind

impl<'a> Parse<'a> for ComponentExportKind<'a>

impl<'a> Parse<'a> for ComponentField<'a>

impl<'a> Parse<'a> for ComponentOuterAliasKind

impl<'a> Parse<'a> for ComponentTypeDecl<'a>

impl<'a> Parse<'a> for ComponentValType<'a>

impl<'a> Parse<'a> for CoreFuncKind<'a>

impl<'a> Parse<'a> for CoreInstanceKind<'a>

impl<'a> Parse<'a> for CoreInstantiationArgKind<'a>

impl<'a> Parse<'a> for CoreTypeDef<'a>

Trait Parse

§When to parse `(` and `)`?

impl<'a, T> Parse<'a> for Box<T>
where T: Parse<'a>,