Add documentation to the ToXml trait

njaremko · Jul 3, 2024 · cd9b3cb · cd9b3cb
1 parent f763adb
commit cd9b3cb
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/traits.rs b/src/traits.rs
@@ -4,8 +4,13 @@ use std::{fmt::Debug, io::Cursor, str::Utf8Error};
 pub trait ToXml<'a> {
     type Error;
 
+    /// Serialize the data structure as a String of XML.
     fn to_string(&'a self) -> Result<String, Self::Error>;
+
+    /// Serialize the data structure as an XML byte vector.
     fn to_vec(&'a self) -> Result<Vec<u8>, Self::Error>;
+
+    /// Serialize the data structure as XML into the I/O stream.
     fn to_writer(&'a self, writer: impl std::io::Write) -> Result<(), Self::Error>;
 }