WIP on state encoding and storage

rust/schema/src/binary/mod.rs

@@ -26,10 +26,12 @@ impl Codec for NativeBinaryCodec {
 }
 
 impl NativeBinaryCodec {
+    /// Encode an object value.
     pub fn encode_object_value<'a, V: ObjectValue, F: WriterFactory>(value: V::In<'a>, writer_factory: &F) -> Result<F::Output, EncodeError> {
         todo!()
     }
 
+    /// Decode an object value.
     pub fn decode_object_value<'a, V: ObjectValue>(input: &'a [u8], memory_manager: &'a MemoryManager) -> Result<V::Out<'a>, DecodeError> {
         todo!()
     }

rust/schema/src/buffer.rs

@@ -68,9 +68,13 @@ impl<'a> Writer for ReverseSliceWriter<'a> {
     }
 }
 
+/// A buffer reader.
 pub trait Reader<'a> {
+    /// Read a slice of bytes from the buffer and update the remaining length.
     fn read_bytes(&mut self, size: usize) -> Result<&'a [u8], DecodeError>;
-    fn done(&self) -> Result<(), DecodeError>;
+
+    /// Check if the buffer has been completely read and return an error if not.
+    fn is_done(&self) -> Result<(), DecodeError>;
 }
 
 impl <'a> Reader<'a> for &'a [u8] {
@@ -83,7 +87,7 @@ impl <'a> Reader<'a> for &'a [u8] {
         Ok(bz)
     }
 
-    fn done(&self) -> Result<(), DecodeError> {
+    fn is_done(&self) -> Result<(), DecodeError> {
         if !self.is_empty() {
             return Err(DecodeError::InvalidData);
         }

rust/schema/src/lib.rs

@@ -21,7 +21,6 @@ mod fields;
 pub mod buffer;
 pub mod mem;
 mod mem2;
-mod stateobject;
 
 pub use structs::{StructCodec};
 pub use r#enum::{EnumCodec};