doc: everything

1 files changed, 37 insertions, 0 deletions

diff --git a/src/writer/endable.rs b/src/writer/endable.rs
new file mode 100644
index 0000000..6d842f3
--- /dev/null
+++ b/src/writer/endable.rs
@@ -0,0 +1,37 @@
+use crate::Error;
+
+#[derive(Debug)]
+pub struct Endable<T> {
+    inner: T,
+    ended: bool,
+}
+
+impl<T> Endable<T> {
+    pub fn new(inner: T) -> Self {
+        Self {
+            inner,
+            ended: false,
+        }
+    }
+
+    pub fn end(&mut self) {
+        self.ended = true;
+    }
+
+    pub fn into_inner(self) -> T {
+        self.inner
+    }
+
+    #[inline(always)]
+    pub fn try_as_mut(&mut self) -> Result<&mut T, Error> {
+        if self.ended {
+            Err(Error::RootElementEnded)
+        } else {
+            Ok(&mut self.inner)
+        }
+    }
+
+    pub fn ignore_end(&mut self) -> &mut T {
+        &mut self.inner
+    }
+}