Enum logos::FilterResult

source ·
pub enum FilterResult<T, E> {
    Emit(T),
    Skip,
    Error(E),
}
Expand description

Type that can be returned from a callback, either producing a field for a token, skipping it, or emitting an error.

§Example

use logos::{Logos, FilterResult};

#[derive(Debug, PartialEq, Clone, Default)]
enum LexingError {
    NumberParseError,
    NumberIsTen,
    #[default]
    Other,
}

impl From<std::num::ParseIntError> for LexingError {
    fn from(_: std::num::ParseIntError) -> Self {
        LexingError::NumberParseError
    }
}

#[derive(Logos, Debug, PartialEq)]
#[logos(error = LexingError)]
enum Token {
    #[regex(r"[ \n\f\t]+", logos::skip)]
    Ignored,

    #[regex("[0-9]+", |lex| {
        let n: u64 = lex.slice().parse().unwrap();

        // Only emit a token if `n` is an even number.
        if n % 2 == 0 {
            // Emit an error if `n` is 10.
            if n == 10 {
                FilterResult::Error(LexingError::NumberIsTen)
            } else {
                FilterResult::Emit(n)
            }
        } else {
            FilterResult::Skip
        }
    })]
    NiceEvenNumber(u64)
}

let tokens: Vec<_> = Token::lexer("20 11 42 23 100 10").collect();

assert_eq!(
    tokens,
    &[
        Ok(Token::NiceEvenNumber(20)),
        // skipping 11
        Ok(Token::NiceEvenNumber(42)),
        // skipping 23
        Ok(Token::NiceEvenNumber(100)),
        // error at 10
        Err(LexingError::NumberIsTen),
    ]
);

Variants§

§

Emit(T)

Emit a token with a given value T. Use () for unit variants without fields.

§

Skip

Skip current match, analog to Skip.

§

Error(E)

Emit a <Token as Logos>::ERROR token.

Auto Trait Implementations§

§

impl<T, E> Freeze for FilterResult<T, E>
where T: Freeze, E: Freeze,

§

impl<T, E> RefUnwindSafe for FilterResult<T, E>

§

impl<T, E> Send for FilterResult<T, E>
where T: Send, E: Send,

§

impl<T, E> Sync for FilterResult<T, E>
where T: Sync, E: Sync,

§

impl<T, E> Unpin for FilterResult<T, E>
where T: Unpin, E: Unpin,

§

impl<T, E> UnwindSafe for FilterResult<T, E>
where T: UnwindSafe, E: UnwindSafe,

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.