fn_bnf

Struct Consume

source 
pub struct Consume<'input, T: 'input + ?Sized, R: Rule<'input, T>>(pub R, _);
Expand description

Matches a rule forever, failing if it does. See Rule::consume_all.

Tuple Fields§

§0: R

Trait Implementations§

source§

impl<'input, T: 'input + ?Sized, R: Rule<'input, T>> NamedRule for Consume<'input, T, R>

source§

fn name(&self) -> Option<&'static str>

Defines the name printed in errors including this rule.
source§

impl<'input, T: 'input, R: Rule<'input, [T]>> Rule<'input, [T]> for Consume<'input, [T], R>

source§

type Output = Vec<<R as Rule<'input, [T]>>::Output>

The type of the value of a successful parse of this rule.
source§

fn parse_at<'cursor, 'this, 'index>( &'this self, input: &'cursor mut &'input [T], index: &'index mut usize, ) -> Result<Self::Output, ParseError>
where 'input: 'this,

Parses a rule at a given index with a given input. Read more
source§

fn parse<'this>( &'this self, input: &'input SliceType, ) -> Result<(&'input SliceType, Self::Output), ParseError>
where 'input: 'this,

Parses a given rule at the start of some input. Read more
source§

fn map_parsed<Output, F: Fn(Self::Output) -> Output>( self, function: F, ) -> Map<'input, SliceType, Self, Output, F>
where Self: Sized,

Maps an infallible function onto the output of a rule.
source§

fn try_map_parsed<Output, E: Error + 'static, F: Fn(Self::Output) -> Result<Output, E>>( self, function: F, ) -> TryMap<'input, SliceType, Self, Output, E, F>
where Self: Sized,

Maps a function onto the output of a rule, passing the error back if it fails.
source§

fn prevent(self) -> Not<Self>
where Self: Sized,

Matches when this fails, and vice versa.
source§

fn repeat_for<const REPS: usize>( self, ) -> RepeatFor<'input, SliceType, Self, REPS>
where Self: Sized,

Repeats this rule a known amount of times.
source§

fn repeat(self, reps: usize) -> Repeat<'input, SliceType, Self>
where Self: Sized,

Repeats this rule a set amount of times.
source§

fn take(self, at_most: usize) -> Many<'input, SliceType, Self>
where Self: Sized,

Repeats this rule at most a set amount of times.
source§

fn hoard(self) -> Many<'input, SliceType, Self>
where Self: Sized,

Repeats this rule forever until it fails.
source§

fn spanned(self) -> Spanned<'input, SliceType, Self>
where Self: Sized, SliceType: Index<RangeTo<usize>, Output = SliceType>,

Captures the output and span of this rule, returning them along with the output in a Span.
source§

fn attempt(self) -> Attempt<'input, SliceType, Self>
where Self: Sized,

Tries to capture this rule, returning None if it doesn’t match.
source§

impl<'input, R: Rule<'input, str>> Rule<'input, str> for Consume<'input, str, R>

source§

type Output = Vec<<R as Rule<'input, str>>::Output>

The type of the value of a successful parse of this rule.
source§

fn parse_at<'cursor, 'this, 'index>( &'this self, input: &'cursor mut &'input str, index: &'index mut usize, ) -> Result<Self::Output, ParseError>
where 'input: 'this,

Parses a rule at a given index with a given input. Read more
source§

fn parse<'this>( &'this self, input: &'input SliceType, ) -> Result<(&'input SliceType, Self::Output), ParseError>
where 'input: 'this,

Parses a given rule at the start of some input. Read more
source§

fn map_parsed<Output, F: Fn(Self::Output) -> Output>( self, function: F, ) -> Map<'input, SliceType, Self, Output, F>
where Self: Sized,

Maps an infallible function onto the output of a rule.
source§

fn try_map_parsed<Output, E: Error + 'static, F: Fn(Self::Output) -> Result<Output, E>>( self, function: F, ) -> TryMap<'input, SliceType, Self, Output, E, F>
where Self: Sized,

Maps a function onto the output of a rule, passing the error back if it fails.
source§

fn prevent(self) -> Not<Self>
where Self: Sized,

Matches when this fails, and vice versa.
source§

fn repeat_for<const REPS: usize>( self, ) -> RepeatFor<'input, SliceType, Self, REPS>
where Self: Sized,

Repeats this rule a known amount of times.
source§

fn repeat(self, reps: usize) -> Repeat<'input, SliceType, Self>
where Self: Sized,

Repeats this rule a set amount of times.
source§

fn take(self, at_most: usize) -> Many<'input, SliceType, Self>
where Self: Sized,

Repeats this rule at most a set amount of times.
source§

fn hoard(self) -> Many<'input, SliceType, Self>
where Self: Sized,

Repeats this rule forever until it fails.
source§

fn spanned(self) -> Spanned<'input, SliceType, Self>
where Self: Sized, SliceType: Index<RangeTo<usize>, Output = SliceType>,

Captures the output and span of this rule, returning them along with the output in a Span.
source§

fn attempt(self) -> Attempt<'input, SliceType, Self>
where Self: Sized,

Tries to capture this rule, returning None if it doesn’t match.

Auto Trait Implementations§

§

impl<'input, T, R> Freeze for Consume<'input, T, R>
where R: Freeze, T: ?Sized,

§

impl<'input, T, R> RefUnwindSafe for Consume<'input, T, R>
where R: RefUnwindSafe, T: RefUnwindSafe + ?Sized,

§

impl<'input, T, R> Send for Consume<'input, T, R>
where R: Send, T: Sync + ?Sized,

§

impl<'input, T, R> Sync for Consume<'input, T, R>
where R: Sync, T: Sync + ?Sized,

§

impl<'input, T, R> Unpin for Consume<'input, T, R>
where R: Unpin, T: ?Sized,

§

impl<'input, T, R> UnwindSafe for Consume<'input, T, R>
where R: UnwindSafe, T: RefUnwindSafe + ?Sized,

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, 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, U> TryFrom<U> for T
where U: Into<T>,

source§

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

source§

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.