exile 0.0.9

DOM-Style XML Parser
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

use std::io::Write;

use crate::xdoc::cdata::write_cdata;
use crate::xdoc::error::Result;
use crate::xdoc::write_ops::write_element_text;
use crate::{Element, Pi, WriteOpts};

#[derive(Debug, Clone, Eq, PartialOrd, Ord, PartialEq, Hash)]
/// Represents a Node in an XML Document. The Document consists of a recursive nesting of these.
pub enum Node {
    /// `<![CDATA[text]]>`
    CData(String),

    /// Comment, e.g. `<!--some comment-->`
    Comment(String),

    // TODO - support doctypes https://github.com/webern/exile/issues/22
    /// `<!DOCTYPE doc>` - not implemented
    DocType(String),

    /// `<element/>`
    Element(Element),

    /// Processing Instruction, e.g. `<?target data?>`
    Pi(Pi),

    /// Text data in an element, i.e. `<x>hello &lt;</x>` where the `Text` is `hello <`.
    Text(String),
}

impl Default for Node {
    fn default() -> Self {
        Node::Element(crate::Element::default())
    }
}

impl Node {
    /// Serialize the XML Document to a `Write` stream.
    pub fn write<W>(&self, writer: &mut W, opts: &WriteOpts, depth: usize) -> Result<()>
    where
        W: Write,
    {
        match self {
            Node::CData(cdata) => write_cdata(cdata, writer),
            Node::Comment(comment) => write_comment(writer, opts, depth, comment),
            Node::DocType(_) => panic!("doctypes unsupported"),
            Node::Element(data) => data.write(writer, opts, depth),
            Node::Pi(pi) => pi.write(writer, opts, depth),
            Node::Text(s) => write_element_text(s.as_str(), writer, opts, depth),
        }
    }

    /// Returns true if this node is either a Node::Text or a Node::CData.
    pub fn is_text(&self) -> bool {
        matches!(self, Node::Text(_) | Node::CData(_))
    }
}

#[derive(Debug, Clone, Eq, PartialOrd, Ord, PartialEq, Hash)]
// TODO - support Whitespace https://github.com/webern/exile/issues/55
/// Represents a "Misc" entry, which is a Processing Instruction (PI), Comment, or Whitespace. These
/// are the types of nodes allowed in the prologue and epilogue of an XML document.
pub enum Misc {
    // TODO - support comments https://github.com/webern/exile/issues/22
    /// `<!-- comment -->` - not implemented
    Comment(String),
    /// ProcessingInstruction, e.g. `<?target whatever?>` - not implemented
    Pi(crate::Pi),
}

impl Default for Misc {
    fn default() -> Self {
        Misc::Comment("".to_owned())
    }
}

impl Misc {
    /// Serialize the XML Document to a `Write` stream.
    pub(crate) fn write<W>(&self, writer: &mut W, opts: &WriteOpts, depth: usize) -> Result<()>
    where
        W: Write,
    {
        match self {
            Misc::Comment(comment) => write_comment(writer, opts, depth, comment),
            Misc::Pi(pi) => pi.write(writer, opts, depth),
        }
    }
}

fn write_comment<W, S>(writer: &mut W, opts: &WriteOpts, depth: usize, comment: S) -> Result<()>
where
    W: Write,
    S: AsRef<str>,
{
    opts.indent(writer, depth)?;
    xwrite!(writer, "<!--{}-->", comment.as_ref())?;
    Ok(())
}