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 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
//! The core crate for [`html-node`](https://docs.rs/html-node).
#![warn(clippy::cargo)]
#![warn(clippy::nursery)]
#![warn(clippy::pedantic)]
#![warn(missing_copy_implementations)]
#![warn(missing_debug_implementations)]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
mod http;
#[allow(missing_docs)]
#[cfg(feature = "typed")]
pub mod typed;
use std::fmt::{self, Display, Formatter};
#[cfg(feature = "typed")]
use self::typed::TypedElement;
/// An HTML node.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Node {
/// A comment.
///
/// ```html
/// <!-- I'm a comment! -->
/// ```
Comment(Comment),
/// A doctype.
///
/// ```html
/// <!DOCTYPE html>
/// ```
Doctype(Doctype),
/// A fragment.
///
/// ```html
/// <>
/// I'm in a fragment!
/// </>
/// ```
Fragment(Fragment),
/// An element.
///
/// ```html
/// <div class="container">
/// I'm in an element!
/// </div>
/// ```
Element(Element),
/// A text node.
///
/// ```html
/// <div>
/// I'm a text node!
/// </div>
/// ```
Text(Text),
/// An unsafe text node.
///
/// # Warning
///
/// [`Node::UnsafeText`] is not escaped when rendered, and as such, can
/// allow for XSS attacks. Use with caution!
UnsafeText(UnsafeText),
}
impl Node {
/// A [`Node::Fragment`] with no children.
pub const EMPTY: Self = Self::Fragment(Fragment {
children: Vec::new(),
});
/// Create a new [`Node`] from a [`TypedElement`].
#[cfg(feature = "typed")]
pub fn from_typed<E: TypedElement>(element: E, children: Option<Vec<Self>>) -> Self {
element.into_node(children)
}
}
impl<I, N> From<I> for Node
where
I: IntoIterator<Item = N>,
N: Into<Self>,
{
fn from(iter: I) -> Self {
Self::Fragment(Fragment {
children: iter.into_iter().map(Into::into).collect(),
})
}
}
impl Display for Node {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
match &self {
Self::Comment(comment) => comment.fmt(f),
Self::Doctype(doctype) => doctype.fmt(f),
Self::Fragment(fragment) => fragment.fmt(f),
Self::Element(element) => element.fmt(f),
Self::Text(text) => text.fmt(f),
Self::UnsafeText(unsafe_text) => unsafe_text.fmt(f),
}
}
}
impl Default for Node {
fn default() -> Self {
Self::EMPTY
}
}
/// A comment.
///
/// ```html
/// <!-- I'm a comment! -->
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Comment {
/// The text of the comment.
///
/// ```html
/// <!-- comment -->
/// ```
pub comment: String,
}
impl Display for Comment {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "<!-- {} -->", self.comment)
}
}
/// A doctype.
///
/// ```html
/// <!DOCTYPE html>
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Doctype {
/// The value of the doctype.
///
/// ```html
/// <!DOCTYPE synax>
/// ```
pub syntax: String,
}
impl Display for Doctype {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "<!DOCTYPE {}>", self.syntax)
}
}
/// A fragment.
///
/// ```html
/// <>
/// I'm in a fragment!
/// </>
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Fragment {
/// The children of the fragment.
///
/// ```html
/// <>
/// <!-- I'm a child! -->
/// <child>I'm another child!</child>
/// </>
pub children: Vec<Node>,
}
impl Display for Fragment {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write_children(f, &self.children, true)
}
}
/// An element.
///
/// ```html
/// <div class="container">
/// I'm in an element!
/// </div>
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Element {
/// The name of the element.
///
/// ```html
/// <name>
/// ```
pub name: String,
/// The attributes of the element.
///
/// ```html
/// <div attribute="value">
/// ```
pub attributes: Vec<(String, Option<String>)>,
/// The children of the element.
///
/// ```html
/// <div>
/// <!-- I'm a child! -->
/// <child>I'm another child!</child>
/// </div>
/// ```
pub children: Option<Vec<Node>>,
}
impl Element {
/// Create a new [`Element`] from a [`TypedElement`].
#[cfg(feature = "typed")]
pub fn from_typed<E: TypedElement>(element: E, children: Option<Vec<Node>>) -> Self {
element.into_element(children)
}
}
impl Display for Element {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "<{}", self.name)?;
for (key, value) in &self.attributes {
write!(f, " {key}")?;
if let Some(value) = value {
let encoded_value = html_escape::encode_double_quoted_attribute(value);
write!(f, r#"="{encoded_value}""#)?;
}
}
write!(f, ">")?;
if let Some(children) = &self.children {
write_children(f, children, false)?;
write!(f, "</{}>", self.name)?;
};
Ok(())
}
}
/// A text node.
///
/// ```html
/// <div>
/// I'm a text node!
/// </div>
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Text {
/// The text of the node.
///
/// ```html
/// <div>
/// text
/// </div>
pub text: String,
}
impl Display for Text {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
let encoded_value = html_escape::encode_text_minimal(&self.text);
write!(f, "{encoded_value}")
}
}
/// An unsafe text node.
///
/// # Warning
///
/// [`UnsafeText`] is not escaped when rendered, and as such, can allow
/// for XSS attacks. Use with caution!
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct UnsafeText {
/// The text of the node.
pub text: String,
}
impl Display for UnsafeText {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.text)
}
}
/// Writes the children of a node.
///
/// If the formatter is in alternate mode, then the children are put on their
/// own lines.
///
/// If alternate mode is enabled and `is_fragment` is false, then each line
/// is indented by 4 spaces.
fn write_children(f: &mut Formatter<'_>, children: &[Node], is_fragment: bool) -> fmt::Result {
if f.alternate() {
let mut children_iter = children.iter();
if is_fragment {
if let Some(first_child) = children_iter.next() {
write!(f, "{first_child:#}")?;
for child in children_iter {
write!(f, "\n{child:#}")?;
}
}
} else {
for child_str in children_iter.map(|child| format!("{child:#}")) {
for line in child_str.lines() {
write!(f, "\n {line}")?;
}
}
// exit inner block
writeln!(f)?;
}
} else {
for child in children {
child.fmt(f)?;
}
}
Ok(())
}