Skip to content

Commit 15be5c4

Browse files
committed
Document content field of the BytesText
1 parent a1935de commit 15be5c4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/events/mod.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -670,7 +670,9 @@ impl<'a> Deref for BytesEnd<'a> {
670670
/// in escaped form. Internally data is stored in escaped form
671671
#[derive(Clone, Eq, PartialEq)]
672672
pub struct BytesText<'a> {
673-
// Invariant: The content is always escaped.
673+
/// Escaped then encoded content of the event. Content is encoded in the XML
674+
/// document encoding when event comes from the reader and should be in the
675+
/// document encoding when event passed to the writer
674676
content: Cow<'a, [u8]>,
675677
}
676678

0 commit comments

Comments
 (0)