dom_renderer 0.2.2

Crate for rendering html (or other DOMs) strings
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

//! Utilities for generating html (or other DOM) strings
//!
//! # Example
//!
//! A simple html page can be created by following codes:
//!
//! ```
//! use dom_renderer::*;
//! 
//! let html = html_basic!(
//!     title: "Page Title",
//!     body:
//!         end_elem!("h1"; "Section"),
//!         end_elem!("p"; "Text goes here..."),
//! );
//! assert_eq!(r#"<!DOCTYPE html><html><head><meta charset="utf-8"><title>Page Title</title></head><body><h1>Section</h1><p>Text goes here...</p></body></html>"#, html.render());
//!
//! let th = elem!("tr";
//!     end_elem!("th"; "Item1"),
//!     end_elem!("th"; "Item2"),
//!     end_elem!("th"; "Item3"),
//! );
//! let tr1 = elem!("tr";
//!     end_elem!("td"; "value 11"),
//!     end_elem!("td"; "value 12"),
//!     end_elem!("td"; "value 13"),
//! );
//! let tr2 = elem!("tr";
//!     end_elem!("td"; "value 21"),
//!     end_elem!("td"; "value 22"),
//!     end_elem!("td"; "value 23"),
//! );
//! let tbl = elem!("table"; ("border", "1"); th, tr1, tr2);
//! assert_eq!(r#"<table border="1"><tr><th>Item1</th><th>Item2</th><th>Item3</th></tr><tr><td>value 11</td><td>value 12</td><td>value 13</td></tr><tr><td>value 21</td><td>value 22</td><td>value 23</td></tr></table>"#, tbl.render());
//! ```
//! 
//! DOM Nodes are represented by `enum DomNode`, which can be created by macros.
//! 
//! Child nodes can be changed using as_XXX() methods. 
//! 
//! ```
//! use dom_renderer::*;
//! 
//! # fn test() -> Option<()> {
//! let mut tbl = elem!("table");
//! let tbl_elem = tbl.as_elem_mut()?;
//! tbl_elem.attributes.push(("border", String::from("1")));
//! // header
//! let mut tr = elem!("tr");
//! let headers = (1..=3)
//!     .map(|i| format!("Item{}", i))
//!     .map(|x| end_elem!("th"; x))
//!     .collect();
//! tr.as_elem_mut()?.child_nodes = headers;
//! tbl_elem.child_nodes.push(tr);
//! // data
//! for i in 1..=2 {
//!     let mut tr = elem!("tr");
//!     let data = (1..=3)
//!         .map(|j| format!("value {}{}", i, j))
//!         .map(|x| end_elem!("td"; x))
//!         .collect();
//!     tr.as_elem_mut()?.child_nodes = data;
//!     tbl_elem.child_nodes.push(tr);
//! }
//! assert_eq!(r#"<table border="1"><tr><th>Item1</th><th>Item2</th><th>Item3</th></tr><tr><td>value 11</td><td>value 12</td><td>value 13</td></tr><tr><td>value 21</td><td>value 22</td><td>value 23</td></tr></table>"#, tbl.render());
//! # Some(())
//! # }
//! ```
//!

pub mod doc_type;
pub mod document;
pub mod element;
pub mod macros;

pub use doc_type::DomDocType;
pub use document::DomDocument;
pub use element::{DomElem, DomEmptyElem};
pub use macros::*;

/// Render recursive elements to String instance
pub trait Render {
    fn render(&self) -> String;
}

/// Node types
/// 
/// # Macros
/// Each variant can be created by the corresponding macro.
/// - `Document`: `domdoc!`
/// - `DocumentType`: `doctype!`
/// - `EmptyElement`: `empty!`
/// - `Element`: `elem!`, `end_elem!`
/// - `Text`: `domtxt!`
#[derive(Debug, Clone)]
pub enum DomNode {
    Document(DomDocument),
    DocumentType(DomDocType),
    EmptyElement(DomEmptyElem),
    Element(DomElem),
    Text(String),
}
pub use DomNode::*;

impl Render for DomNode {
    fn render(&self) -> String {
        match self {
            Document(n) => n.render(),
            DocumentType(n) => n.render(),
            EmptyElement(n) => n.render(),
            Element(n) => n.render(),
            Text(n) => n.clone(),
        }
    }
}

impl DomNode {
    pub fn as_doc(&self) -> Option<&DomDocument> {
        match *self {
            Document(ref e) => Some(e),
            _ => None,
        }
    }

    pub fn as_doc_mut(&mut self) -> Option<&mut DomDocument> {
        match *self {
            Document(ref mut e) => Some(e),
            _ => None,
        }
    }

    pub fn as_doctype(&self) -> Option<&DomDocType> {
        match *self {
            DocumentType(ref e) => Some(e),
            _ => None,
        }
    }

    pub fn as_doctype_mut(&mut self) -> Option<&mut DomDocType> {
        match *self {
            DocumentType(ref mut e) => Some(e),
            _ => None,
        }
    }

    pub fn as_empty(&self) -> Option<&DomEmptyElem> {
        match *self {
            EmptyElement(ref e) => Some(e),
            _ => None,
        }
    }

    pub fn as_empty_mut(&mut self) -> Option<&mut DomEmptyElem> {
        match *self {
            EmptyElement(ref mut e) => Some(e),
            _ => None,
        }
    }

    pub fn as_elem(&self) -> Option<&DomElem> {
        match *self {
            Element(ref e) => Some(e),
            _ => None,
        }
    }

    pub fn as_elem_mut(&mut self) -> Option<&mut DomElem> {
        match *self {
            Element(ref mut e) => Some(e),
            _ => None,
        }
    }

    pub fn as_text(&self) -> Option<&String> {
        match *self {
            Text(ref e) => Some(e),
            _ => None,
        }
    }

    pub fn as_text_mut(&mut self) -> Option<&mut String> {
        match *self {
            Text(ref mut e) => Some(e),
            _ => None,
        }
    }
}