Merge pull request #190 from Spartan2909/main

Make `IOReader` and `EIOReader` constructors public
jamesmunns · Nov 27, 2024 · bfb6b73 · bfb6b73
2 parents 039bb1e + f736abe
commit bfb6b73
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/source/postcard/src/de/flavors.rs b/source/postcard/src/de/flavors.rs
@@ -261,7 +261,10 @@ pub mod io {
         where
             T: crate::eio::Read,
         {
-            pub(crate) fn new(reader: T, buff: &'de mut [u8]) -> Self {
+            /// Create a new [`EIOReader`] from a reader and a buffer.
+            ///
+            /// `buff` must have enough space to hold all data read during the deserialisation.
+            pub fn new(reader: T, buff: &'de mut [u8]) -> Self {
                 Self {
                     reader,
                     buff: SlidingBuffer::new(buff),
@@ -328,7 +331,10 @@ pub mod io {
         where
             T: std::io::Read,
         {
-            pub(crate) fn new(reader: T, buff: &'de mut [u8]) -> Self {
+            /// Create a new [`IOReader`] from a reader and a buffer.
+            ///
+            /// `buff` must have enough space to hold all data read during the deserialisation.
+            pub fn new(reader: T, buff: &'de mut [u8]) -> Self {
                 Self {
                     reader,
                     buff: SlidingBuffer::new(buff),