scnr2 0.5.2

Scanner/Lexer with regex patterns and multiple modes
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
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Module for position types used in the scanner.
use std::fmt::Display;

/// A position in the input.
/// The position is represented by a line and column number.
/// The line and column numbers are 1-based.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Position {
    /// The line number in the input.
    pub line: usize,
    /// The column number in the input.
    pub column: usize,
}

impl Position {
    /// Creates a new `Position` with the given line and column numbers.
    pub fn new(line: usize, column: usize) -> Self {
        Position { line, column }
    }
}

impl Default for Position {
    /// Returns a default `Position` at line 1, column 1.
    fn default() -> Self {
        Position { line: 1, column: 1 }
    }
}

impl std::fmt::Display for Position {
    /// Formats the position as "line:column".
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}:{}", self.line, self.column)
    }
}

/// Represents the start and end positions of a match in the input.
#[derive(Debug, Clone, Default)]
pub struct Positions {
    /// The line and column number where the match started (inclusive).
    pub start_position: Position,
    /// The line and column number where the match ended (exclusive).
    pub end_position: Position,
}

impl Positions {
    /// Creates a new `Positions` with the given start and end positions.
    pub fn new(start_position: Position, end_position: Position) -> Self {
        Positions {
            start_position,
            end_position,
        }
    }
}

impl Display for Positions {
    /// Formats the positions as "start_line:start_column-end_line:end_column".
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}-{}", self.start_position, self.end_position)
    }
}