Document content field of the BytesText

tafia · Jul 12, 2022 · 15be5c4 · 15be5c4
1 parent a1935de
commit 15be5c4
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/events/mod.rs b/src/events/mod.rs
@@ -670,7 +670,9 @@ impl<'a> Deref for BytesEnd<'a> {
 /// in escaped form. Internally data is stored in escaped form
 #[derive(Clone, Eq, PartialEq)]
 pub struct BytesText<'a> {
-    // Invariant: The content is always escaped.
+    /// Escaped then encoded content of the event. Content is encoded in the XML
+    /// document encoding when event comes from the reader and should be in the
+    /// document encoding when event passed to the writer
     content: Cow<'a, [u8]>,
 }