Struct proclet::OpParser

pub struct OpParser<P: PunctExt, F: MatchOpFn>(/* private fields */);

Parser for specific sets of operators. Ops can be parsed via Parser or manually from Puncts.

Implementations

impl<P: PunctExt, F: MatchOpFn> OpParser<P, F>

pub const fn new(match_op: F) -> Self

Create a new OpParser using match_op to define the valid operators. Usually you wouldn’t call this directly, but create the OpParser using a function generated by the define_ops macro in the proclet-utils crate. If you want to parse a single Op using Parser, use Op instead.

See OpParser::match_op for details of how match_op should work.

pub fn create(&self) -> OpParserInstance<P, F>

Create a new OpParserInstance for this OpParser. You only need this if you don’t use Parser::parse or parse_ops.

pub fn parse_ops<I: Iterator<Item = P>>( &self, puncts: I ) -> ParseOps<P::Span, I, F>

Use this OpParser to parse operators from an iterator of Puncts.

pub fn match_op( &self, str: &str, next: Option<char> ) -> Match<Cow<'static, str>>

Check if str is a valid op.

For example, if + and += are valid ops and +- is invalid:

• match_op("+", Some('=')) returns Match::Partial("+")
• match_op("+", Some('-')) returns Match::Complete("+")
• match_op("+", None) returns Match::Complete("+")
• match_op("+=", None) returns Match::Complete("+=")
• match_op("+-", None) returns Match::None

If -= is a valid op, and - and -+ are invalid:

• match_op("-", Some('=')) returns Match::NeedMore
• match_op("-", Some('+')) returns Match::None
• match_op("-", None) returns Match::None
• match_op("-=", None) returns Match::Complete("-=")

Trait Implementations

impl<P: Clone + PunctExt, F: Clone + MatchOpFn> Clone for OpParser<P, F>

fn clone(&self) -> OpParser<P, F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<P: PunctExt, F: MatchOpFn> Parser<<P as ProcMacro>::TokenTree> for OpParser<P, F>

type Output<'p, 'b> = Op<<P as ProcMacro>::Span> where Self: 'p

The output type of this parser.

fn parse<'p, 'b>( &'p self, buf: &mut &'b TokenBuf<P::TokenTree> ) -> Result<Self::Output<'p, 'b>, Error<P::Span>>

Parse a value from a TokenBuf using this parser.

fn parse_all<'p, 'b>( &'p self, buf: &mut &'b TokenBuf<T> ) -> Result<Self::Output<'p, 'b>, Error<T::Span>>

Parse a value from a TokenBuf buffer, but return an error if there’s any tokens left in the buffer after parsing.

fn optional(self) -> Optional<Self>

where Self: Sized,

Wrap this parser in Optional to make it always succeed and return an option.