Merge pull request #836 from pronebird/utf8writer

Add to_utf8_io_writer helper serializing into std::io::Write

Author: Mingun

Changelog.md

@@ -15,10 +15,14 @@
 
 ### New Features
 
+- [#836]: Add `se::to_utf8_io_writer()` helper compatible with `std::io::Write` and restricted to UTF-8 encoding.
+
 ### Bug Fixes
 
 ### Misc Changes
 
+[#836]: https://github.com/tafia/quick-xml/pull/836
+
 
 ## 0.37.1 -- 2024-11-17
 

src/se/mod.rs

@@ -82,7 +82,7 @@ mod text;
 use self::content::ContentSerializer;
 use self::element::{ElementSerializer, Map, Struct, Tuple};
 use crate::de::TEXT_KEY;
-use crate::writer::Indentation;
+use crate::writer::{Indentation, ToFmtWrite};
 use serde::ser::{self, Serialize};
 use serde::serde_if_integer128;
 use std::fmt::Write;
@@ -136,6 +136,54 @@ where
     value.serialize(Serializer::new(&mut writer))
 }
 
+/// Serialize struct into a `io::Write`r restricted to utf-8 encoding.
+///
+/// Returns the classification of the last written type.
+///
+/// # Examples
+///
+/// ```
+/// # use quick_xml::se::to_utf8_io_writer;
+/// # use serde::Serialize;
+/// # use pretty_assertions::assert_eq;
+/// # use std::io::BufWriter;
+/// # use std::str;
+/// #[derive(Serialize)]
+/// struct Root<'a> {
+///     #[serde(rename = "@attribute")]
+///     attribute: &'a str,
+///     element: &'a str,
+///     #[serde(rename = "$text")]
+///     text: &'a str,
+/// }
+///
+/// let data = Root {
+///     attribute: "attribute content",
+///     element: "element content",
+///     text: "text content",
+/// };
+///
+/// let mut buffer = Vec::new();
+/// to_utf8_io_writer(&mut BufWriter::new(&mut buffer), &data).unwrap();
+///
+/// assert_eq!(
+///     str::from_utf8(&buffer).unwrap(),
+///     // The root tag name is automatically deduced from the struct name
+///     // This will not work for other types or struct with #[serde(flatten)] fields
+///     "<Root attribute=\"attribute content\">\
+///         <element>element content</element>\
+///         text content\
+///     </Root>"
+/// );
+/// ```
+pub fn to_utf8_io_writer<W, T>(writer: W, value: &T) -> Result<WriteResult, SeError>
+where
+    W: std::io::Write,
+    T: ?Sized + Serialize,
+{
+    value.serialize(Serializer::new(&mut ToFmtWrite(writer)))
+}
+
 /// Serialize struct into a `String`.
 ///
 /// # Examples

src/writer.rs

@@ -577,7 +577,7 @@ impl<'a, W: Write> ElementWriter<'a, W> {
     }
 }
 #[cfg(feature = "serialize")]
-struct ToFmtWrite<T>(pub T);
+pub(crate) struct ToFmtWrite<T>(pub T);
 
 #[cfg(feature = "serialize")]
 impl<T> std::fmt::Write for ToFmtWrite<T>