domrs 0.0.17

Document builder and serializer
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

use crate::html::DEFAULT_HTML_OFFSET;
use crate::{HtmlBodyElement, HtmlElement, HtmlHeadElement, ToText, DEFAULT_HTML_DOCTYPE, DEFAULT_HTML_INDENT, DEFAULT_HTML_LANGUAGE, DEFAULT_HTML_NAMESPACE};
use std::fmt::{Display, Write};
use std::{fmt, fs, io};

/// A structure representing HTML document.
#[derive(Debug, Clone)]
pub struct HtmlDocument {
  /// Document type.
  doctype: Option<String>,
  /// Document element.
  root: HtmlElement,
}

impl Default for HtmlDocument {
  /// Creates the default HTML document.
  fn default() -> Self {
    Self {
      doctype: None,
      root: HtmlElement::new("html").no_indent(),
    }
  }
}

impl HtmlDocument {
  /// Creates an empty HTML document.
  pub fn new() -> Self {
    Self::default()
  }

  /// Uses default doctype declaration.
  pub fn default_doctype(mut self) -> Self {
    self.doctype = DEFAULT_HTML_DOCTYPE.to_string().into();
    self
  }

  /// Uses custom doctype declaration.
  pub fn doctype(mut self, doctype: &str) -> Self {
    self.doctype = doctype.to_string().into();
    self
  }

  /// Uses default namespace.
  pub fn default_namespace(mut self) -> Self {
    self.root.set_attribute("xmlns", DEFAULT_HTML_NAMESPACE);
    self
  }

  /// Uses custom namespace.
  pub fn namespace(mut self, namespace: &str) -> Self {
    self.root.set_attribute("xmlns", namespace);
    self
  }

  /// Uses default language.
  pub fn default_language(mut self) -> Self {
    self.root.set_attribute("lang", DEFAULT_HTML_LANGUAGE);
    self
  }

  /// Uses custom language.
  pub fn language(mut self, language: &str) -> Self {
    self.root.set_attribute("lang", language);
    self
  }

  /// Uses custom head element.
  pub fn head(mut self, head: HtmlHeadElement) -> Self {
    self.root.add_child(head);
    self
  }

  /// Uses custom body element.
  pub fn body(mut self, body: HtmlBodyElement) -> Self {
    self.root.add_child(body);
    self
  }

  /// Saves the document to specified file.
  pub fn save(&self, file_name: &str, offset: usize, indent: usize) -> io::Result<()> {
    fs::write(file_name, self.to_text(offset, indent))
  }
}

impl ToText for HtmlDocument {
  /// Converts [HtmlDocument] to textual representation using provided offset and indent.
  fn to_text(&self, offset: usize, indent: usize) -> String {
    let mut buffer = String::new();
    if let Some(doctype) = &self.doctype {
      let _ = writeln!(&mut buffer, "{}", doctype);
    }
    self.root.write(offset, indent, &mut buffer);
    let _ = writeln!(&mut buffer);
    buffer
  }
}

impl Display for HtmlDocument {
  /// Converts [HtmlDocument] into its text representation.
  fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
    write!(f, "{}", self.to_text(DEFAULT_HTML_OFFSET, DEFAULT_HTML_INDENT))
  }
}