add comments

capnproto · Nov 15, 2023 · 6c28dc8 · 6c28dc8
1 parent 4cb9abc
commit 6c28dc8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/capnp/src/serialize.rs b/capnp/src/serialize.rs
@@ -310,6 +310,8 @@ where
 }
 
 /// Like `try_read_message()`, but does not allocate any memory.
+/// Stores the message in `buffer`. Returns a `BufferNotLargeEnough`
+/// error if the buffer is not large enough.
 pub fn try_read_message_no_alloc<R>(
     mut read: R,
     options: message::ReaderOptions,
@@ -387,6 +389,8 @@ where
 }
 
 /// Like `read_message()`, but does not allocate.
+/// Stores the message in `buffer`. Returns a `BufferNotLargeEnough`
+/// error if the buffer is not large enough.
 pub fn read_message_no_alloc<R>(
     read: R,
     options: message::ReaderOptions,

diff --git a/capnp/src/serialize_packed.rs b/capnp/src/serialize_packed.rs
@@ -255,6 +255,8 @@ where
 }
 
 /// Like read_message(), but does not allocate.
+/// Stores the message in `buffer`. Returns a `BufferNotLargeEnough`
+/// error if the buffer is not large enough.
 pub fn read_message_no_alloc<R>(
     read: R,
     options: message::ReaderOptions,
@@ -268,6 +270,8 @@ where
 }
 
 /// Like try_read_message(), but does not allocate.
+/// Stores the message in `buffer`. Returns a `BufferNotLargeEnough`
+/// error if the buffer is not large enough.
 pub fn try_read_message_no_alloc<R>(
     read: R,
     options: message::ReaderOptions,