note-mark 0.0.2

A markdown parser.
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
61
62
63
64
65

//! Token.

/// The struct to represent a token.
///
/// Token contains the kind of token and the range of the token in the source.
/// The range is represented by the start position and the length of the token.
///
/// Note!: **This struct can live longer than the source string.**
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Token {
    /// The kind of the token.
    pub kind: TokenKind,
    /// The start position of the token.
    pub start: usize,
    /// The length of the token.
    pub len: usize,
}

impl Token {
    /// Get the range of the token.
    pub fn range(&self) -> std::ops::Range<usize> {
        self.start..self.start + self.len
    }
}

/// The enum to represent a token kind.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TokenKind {
    Text,
    /// " "
    Space,
    /// "\t"
    Tab,
    Break,
    /// "\\"
    Backslash,
    /// "#"
    Pound,
    /// "*"
    Star,
    /// ":"
    Colon,
    /// "`"
    Backquote,
    /// ">"
    Gt,
    /// "-"
    Hyphen,
    /// "|"
    VerticalBar,
    /// "."
    Dot,
    /// "("
    OpenParen,
    /// ")"
    CloseParen,
    /// "{"
    OpenBrace,
    /// "}"
    CloseBrace,
    /// "["
    OpenBracket,
    /// "]"
    CloseBracket,
}