jpar 0.1.0

A text-oriented, zero-copy, parser combinators library
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

/// A specific position inside a `Reader`.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Cursor {
    byte_offset: usize,
    char_offset: usize,
    line: usize,
    column: usize,
}

impl Cursor {
    // CONSTRUCTORS -----------------------------------------------------------

    /// Builds a new `Cursor` with the specified data.
    pub(in crate::reader) fn new(
        byte_offset: usize,
        char_offset: usize,
        line: usize,
        column: usize,
    ) -> Cursor {
        Cursor {
            byte_offset,
            char_offset,
            line,
            column,
        }
    }

    // GETTERS ----------------------------------------------------------------

    /// The position of the `Cursor` in bytes.
    #[inline]
    pub fn byte_offset(&self) -> usize {
        self.byte_offset
    }

    /// The position of the `Cursor` in characters.
    #[inline]
    pub fn char_offset(&self) -> usize {
        self.char_offset
    }

    /// The line number in which the `Cursor` is placed.
    /// It starts at line 1.
    #[inline]
    pub fn line(&self) -> usize {
        self.line
    }

    /// The column number in which the `Cursor` is placed.
    /// It starts at column 1.
    #[inline]
    pub fn column(&self) -> usize {
        self.column
    }
}