oak-handlebars 0.0.11

Handlebars template engine parser with support for modern templating features and extensions.
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

#![doc = include_str!("readme.md")]
use core::range::Range;

/// Strongly-typed AST root node for Handlebars templates.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct HandlebarsRoot {
    /// List of nodes in the template.
    pub nodes: Vec<TemplateNode>,
}

/// Enum representing a template node.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum TemplateNode {
    /// Plain text content.
    Content(Content),
    /// Mustache expression.
    Mustache(Mustache),
    /// Block expression.
    Block(Block),
    /// Comment.
    Comment(Comment),
    /// Partial template reference.
    Partial(Partial),
}

/// Node representing plain text content.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Content {
    /// Text content.
    pub text: String,
    /// Span in the source code.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Node representing a Mustache expression.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Mustache {
    /// Expression content.
    pub expression: Expression,
    /// Whether the output is unescaped ({{{...}}}).
    pub is_unescaped: bool,
    /// Span in the source code.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Node representing a block expression.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Block {
    /// Block name.
    pub name: String,
    /// List of parameters.
    pub params: Vec<Expression>,
    /// Block body content.
    pub body: Vec<TemplateNode>,
    /// Inverse block content (else).
    pub inverse: Option<Vec<TemplateNode>>,
    /// Span in the source code.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Node representing a comment.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Comment {
    /// Comment text.
    pub text: String,
    /// Span in the source code.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Node representing a partial template reference.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Partial {
    /// Partial template name.
    pub name: String,
    /// List of parameters.
    pub params: Vec<Expression>,
    /// Span in the source code.
    #[cfg_attr(feature = "serde", serde(with = "oak_core::serde_range"))]
    pub span: Range<usize>,
}

/// Enum representing an expression.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Expression {
    /// Path expression.
    Path(String),
    /// Literal
    Literal(Literal),
    /// Sub-expression
    SubExpression(Box<Expression>),
}

/// Literal enum
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Literal {
    /// String literal
    String(String),
    /// Number literal
    Number(f64),
    /// Boolean literal
    Boolean(bool),
}