xso: introduce AsXml trait

Jonas Schäfer created 2 years ago

This will soon replace the IntoXml trait. The idea here is that we
don't generally need to take ownership of values which are going to
be transformed into XML: most of the time, the XML text is created
by building a string from some more specific type, such as an
integer or an enum. Requiring to clone an entire structure for this
purpose is wasteful.

In other cases, we actually could reference data right from the structs
we are converting to XML. In those cases, assuming that an iterator
always generates owned data would be incorrect, too.

Hence, we introduce a new `Item` type which closely mirrors the
`rxml::Item` type, but where the constituents are `Cow`. In the upcoming
changes, we are going to work toward replacing all uses of `IntoXml`
with `AsXml`, as well as modifying the macros accordingly.

Change summary

xso/src/lib.rs       | 27 +++++++++++++
xso/src/rxml_util.rs | 92 ++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 119 insertions(+)

Detailed changes

xso/src/lib.rs

@@ -24,6 +24,7 @@ pub mod error;
 #[cfg(feature = "minidom")]
 #[cfg_attr(docsrs, doc(cfg(feature = "minidom")))]
 pub mod minidom_compat;
+mod rxml_util;
 pub mod text;
 
 #[doc(hidden)]
@@ -38,6 +39,9 @@ use std::borrow::Cow;
 #[doc(inline)]
 pub use text::TextCodec;
 
+#[doc(inline)]
+pub use rxml_util::Item;
+
 #[doc = include_str!("from_xml_doc.md")]
 #[doc(inline)]
 #[cfg(feature = "macros")]
@@ -75,6 +79,29 @@ pub trait IntoXml {
     fn into_event_iter(self) -> Result<Self::EventIter, self::error::Error>;
 }
 
+/// Trait allowing to iterate a struct's contents as serialisable
+/// [`Item`]s.
+///
+/// **Important:** Changing the [`ItemIter`][`Self::ItemIter`] associated
+/// type is considered a non-breaking change for any given implementation of
+/// this trait. Always refer to a type's iterator type using fully-qualified
+/// notation, for example: `<T as xso::AsXml>::ItemIter`.
+pub trait AsXml {
+    /// The iterator type.
+    ///
+    /// **Important:** Changing this type is considered a non-breaking change
+    /// for any given implementation of this trait. Always refer to a type's
+    /// iterator type using fully-qualified notation, for example:
+    /// `<T as xso::AsXml>::ItemIter`.
+    type ItemIter<'x>: Iterator<Item = Result<Item<'x>, self::error::Error>>
+    where
+        Self: 'x;
+
+    /// Return an iterator which emits the contents of the struct or enum as
+    /// serialisable [`Item`] items.
+    fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, self::error::Error>;
+}
+
 /// Trait for a temporary object allowing to construct a struct from
 /// [`rxml::Event`] items.
 ///

xso/src/rxml_util.rs

@@ -0,0 +1,92 @@
+// Copyright (c) 2024 Jonas Schäfer <[e-mail]>
+//
+// 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/.
+
+//! Utilities which may eventually move upstream to the `rxml` crate.
+
+use std::borrow::Cow;
+
+use rxml::{Namespace, NcNameStr, XmlVersion};
+
+/// An encodable item.
+///
+/// Unlike [`rxml::Item`], the contents of this item may either be owned or
+/// borrowed, individually. This enables the use in an [`crate::AsXml`] trait
+/// even if data needs to be generated during serialisation.
+#[derive(Debug)]
+pub enum Item<'x> {
+    /// XML declaration
+    XmlDeclaration(XmlVersion),
+
+    /// Start of an element header
+    ElementHeadStart(
+        /// Namespace name
+        Namespace,
+        /// Local name of the attribute
+        Cow<'x, NcNameStr>,
+    ),
+
+    /// An attribute key/value pair
+    Attribute(
+        /// Namespace name
+        Namespace,
+        /// Local name of the attribute
+        Cow<'x, NcNameStr>,
+        /// Value of the attribute
+        Cow<'x, str>,
+    ),
+
+    /// End of an element header
+    ElementHeadEnd,
+
+    /// A piece of text (in element content, not attributes)
+    Text(Cow<'x, str>),
+
+    /// Footer of an element
+    ///
+    /// This can be used either in places where [`Text`] could be used to
+    /// close the most recently opened unclosed element, or it can be used
+    /// instead of [`ElementHeadEnd`] to close the element using `/>`, without
+    /// any child content.
+    ///
+    ///   [`Text`]: Self::Text
+    ///   [`ElementHeadEnd`]: Self::ElementHeadEnd
+    ElementFoot,
+}
+
+impl Item<'_> {
+    /// Exchange all borrowed pieces inside this item for owned items, cloning
+    /// them if necessary.
+    pub fn into_owned(self) -> Item<'static> {
+        match self {
+            Self::XmlDeclaration(v) => Item::XmlDeclaration(v),
+            Self::ElementHeadStart(ns, name) => {
+                Item::ElementHeadStart(ns, Cow::Owned(name.into_owned()))
+            }
+            Self::Attribute(ns, name, value) => Item::Attribute(
+                ns,
+                Cow::Owned(name.into_owned()),
+                Cow::Owned(value.into_owned()),
+            ),
+            Self::ElementHeadEnd => Item::ElementHeadEnd,
+            Self::Text(value) => Item::Text(Cow::Owned(value.into_owned())),
+            Self::ElementFoot => Item::ElementFoot,
+        }
+    }
+
+    /// Return an [`rxml::Item`], which borrows data from this item.
+    pub fn as_rxml_item<'x>(&'x self) -> rxml::Item<'x> {
+        match self {
+            Self::XmlDeclaration(ref v) => rxml::Item::XmlDeclaration(*v),
+            Self::ElementHeadStart(ref ns, ref name) => rxml::Item::ElementHeadStart(ns, &**name),
+            Self::Attribute(ref ns, ref name, ref value) => {
+                rxml::Item::Attribute(ns, &**name, &**value)
+            }
+            Self::ElementHeadEnd => rxml::Item::ElementHeadEnd,
+            Self::Text(ref value) => rxml::Item::Text(&**value),
+            Self::ElementFoot => rxml::Item::ElementFoot,
+        }
+    }
+}