// Copyright (c) 2020 lumi // Copyright (c) 2020 Emmanuel Gil Peyrot // Copyright (c) 2020 Maxime “pep” Buquet // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. //! Provides the `Node` struct, which represents a node in the DOM. use crate::element::{Element, ElementBuilder, ItemWriter}; use crate::error::Result; use rxml::writer::Item; use std::io::Write; /// A node in an element tree. #[derive(Clone, Debug, Eq)] pub enum Node { /// An `Element`. Element(Element), /// A text node. Text(String), } impl Node { /// Turns this into a reference to an `Element` if this is an element node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let elm = Node::Element("".parse().unwrap()); /// let txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.as_element().unwrap().name(), "meow"); /// assert_eq!(txt.as_element(), None); /// ``` pub fn as_element(&self) -> Option<&Element> { match *self { Node::Element(ref e) => Some(e), Node::Text(_) => None, } } /// Turns this into a mutable reference of an `Element` if this is an element node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let mut elm = Node::Element("".parse().unwrap()); /// let mut txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.as_element_mut().unwrap().name(), "meow"); /// assert_eq!(txt.as_element_mut(), None); /// ``` pub fn as_element_mut(&mut self) -> Option<&mut Element> { match *self { Node::Element(ref mut e) => Some(e), Node::Text(_) => None, } } /// Turns this into an `Element`, consuming self, if this is an element node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let elm = Node::Element("".parse().unwrap()); /// let txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.into_element().unwrap().name(), "meow"); /// assert_eq!(txt.into_element(), None); /// ``` pub fn into_element(self) -> Option { match self { Node::Element(e) => Some(e), Node::Text(_) => None, } } /// Turns this into an `&str` if this is a text node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let elm = Node::Element("".parse().unwrap()); /// let txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.as_text(), None); /// assert_eq!(txt.as_text().unwrap(), "meow"); /// ``` pub fn as_text(&self) -> Option<&str> { match *self { Node::Element(_) => None, Node::Text(ref s) => Some(s), } } /// Turns this into an `&mut String` if this is a text node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let mut elm = Node::Element("".parse().unwrap()); /// let mut txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.as_text_mut(), None); /// { /// let text_mut = txt.as_text_mut().unwrap(); /// assert_eq!(text_mut, "meow"); /// text_mut.push_str("zies"); /// assert_eq!(text_mut, "meowzies"); /// } /// assert_eq!(txt.as_text().unwrap(), "meowzies"); /// ``` pub fn as_text_mut(&mut self) -> Option<&mut String> { match *self { Node::Element(_) => None, Node::Text(ref mut s) => Some(s), } } /// Turns this into an `String`, consuming self, if this is a text node. /// Else this returns `None`. /// /// # Examples /// /// ```rust /// use minidom::Node; /// /// let elm = Node::Element("".parse().unwrap()); /// let txt = Node::Text("meow".to_owned()); /// /// assert_eq!(elm.into_text(), None); /// assert_eq!(txt.into_text().unwrap(), "meow"); /// ``` pub fn into_text(self) -> Option { match self { Node::Element(_) => None, Node::Text(s) => Some(s), } } #[doc(hidden)] pub(crate) fn write_to_inner(&self, writer: &mut ItemWriter) -> Result<()> { match *self { Node::Element(ref elmt) => elmt.write_to_inner(writer)?, Node::Text(ref s) => { writer.write(Item::Text((&**s).try_into()?))?; } } Ok(()) } } impl From for Node where I: Into, { fn from(elm: I) -> Node { Node::Element(elm.into()) } } impl From for Node { fn from(s: String) -> Node { Node::Text(s) } } impl<'a> From<&'a str> for Node { fn from(s: &'a str) -> Node { Node::Text(s.to_owned()) } } impl From for Node { fn from(builder: ElementBuilder) -> Node { Node::Element(builder.build()) } } impl PartialEq for Node { fn eq(&self, other: &Self) -> bool { match (self, other) { (Node::Element(elem1), Node::Element(elem2)) => elem1 == elem2, (Node::Text(text1), Node::Text(text2)) => text1 == text2, _ => false, } } }