trimmer 0.3.6

A whitespace- and memory-friendly template engine
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

//! Trimmer: A yet another text template engine
//!
//! [User Guide](https://trimmer.readthedocs.io/) |
//! [Github](https://github.com/tailhook/trimmer/) |
//! [Crate](https://crates.io/crates/trimmer)
//!
#![recursion_limit="100"]
#![warn(missing_docs)]

extern crate combine;
extern crate owning_ref;
extern crate regex;
#[macro_use] extern crate quick_error;
#[macro_use] extern crate matches;
#[cfg(test)] #[macro_use] extern crate difference;
#[cfg(feature="json")] extern crate serde_json;

mod compare;
mod escape;
mod grammar;
mod helpers;
mod indent;
mod number;
mod oneline;
mod optimize;
mod options;
mod output;
mod owning;
mod parse_error;
mod position;
mod preparser;
mod render;
mod render_error;
mod std_vars;
mod box_vars;
mod tokenizer;
mod validators;
mod varmap;
mod vars;
#[cfg(feature="json")] mod serde;
#[cfg(test)] mod tests;

pub use grammar::Parser;
pub use parse_error::ParseError;
pub use position::Pos;
pub use render_error::{RenderError, DataError};
pub use render::Template;
pub use vars::{Variable};
pub use varmap::Context;
pub use number::Number;
pub use compare::Comparable;
#[cfg(feature="json")] pub use serde::render_json;

use std::collections::HashMap;

use vars::Val;

#[derive(Debug, Clone)]
/// Options of the template
///
/// Usually all options are set in the template itself using
/// `## syntax ...` and `## validator...` directives, but this object
/// can be prefilled with better default that suit your application. For
/// example, if you use template for a log message it's good idea to use
/// `## syntax: oneline` but it's tedious to write it every time.
pub struct Options {
    syntax: preparser::Syntax,
    new_line_at_eof: Option<bool>,
    // parenthesis
    curly: bool,
    square: bool,
    round: bool,

    default_filter: validators::Filter,
    filters: HashMap<String, validators::Filter>,
}

/// Variable reference returned from methods of Variable trait
///
/// It can contain borrowed reference from current variable or
/// owned (reference counted) box to another object
pub struct Var<'a, 'render: 'a>(Val<'a, 'render>);


/// A value returned from `Variable::output`
///
/// Usually it should borrow some displayable value, but may also
/// contain an boxed thing.
pub struct Output<'x>(output::OutImpl<'x>);