lex-core 0.8.2

Parser library for the lex format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

//! Common lexer module
//!
//! This module contains shared interfaces and utilities for lexer implementations.

use crate::lex::token::Token;
use std::fmt;
use std::ops::Range;

/// Output from a lexer
#[derive(Debug, Clone)]
pub enum LexerOutput {
    /// Flat sequence of tokens
    Flat(Vec<(Token, Range<usize>)>),
}

/// Errors that can occur during lexing
#[derive(Debug, Clone)]
pub enum LexError {
    /// Generic error message
    Error(String),
    /// Error during transformation phase
    Transformation(String),
}

impl fmt::Display for LexError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            LexError::Error(msg) => write!(f, "Lexing error: {msg}"),
            LexError::Transformation(msg) => write!(f, "Transformation error: {msg}"),
        }
    }
}

impl std::error::Error for LexError {}

impl From<LexError> for String {
    fn from(err: LexError) -> Self {
        err.to_string()
    }
}

/// Trait for lexer implementations
pub trait Lexer {
    /// Lex the source text
    fn lex(&self, source: &str) -> Result<LexerOutput, LexError>;
}