Expose trait externally

tokio-rs · Feb 15, 2024 · bba4b45 · bba4b45
1 parent 232ebc2
commit bba4b45
Show file tree

Hide file tree

Showing 11 changed files with 28 additions and 23 deletions.
diff --git a/src/fs/file.rs b/src/fs/file.rs
@@ -4,7 +4,7 @@ use crate::fs::OpenOptions;
 use crate::io::SharedFd;
 
 use crate::runtime::driver::op::Op;
-use crate::sealed::MapResult;
+use crate::MapResult;
 use crate::{UnsubmittedOneshot, UnsubmittedWrite};
 use std::fmt;
 use std::io;

diff --git a/src/io/read.rs b/src/io/read.rs
@@ -1,7 +1,7 @@
 use crate::buf::BoundedBufMut;
 use crate::io::SharedFd;
-use crate::sealed::WithBuffer;
 use crate::Result;
+use crate::WithBuffer;
 
 use crate::runtime::driver::op::{Completable, CqeResult, Op};
 use crate::runtime::CONTEXT;

diff --git a/src/io/readv.rs b/src/io/readv.rs
@@ -1,6 +1,6 @@
 use crate::buf::BoundedBufMut;
-use crate::sealed::WithBuffer;
 use crate::Result;
+use crate::WithBuffer;
 
 use crate::io::SharedFd;
 use crate::runtime::driver::op::{Completable, CqeResult, Op};

diff --git a/src/io/recv_from.rs b/src/io/recv_from.rs
@@ -1,6 +1,6 @@
 use crate::runtime::driver::op::{Completable, CqeResult, Op};
 use crate::runtime::CONTEXT;
-use crate::sealed::WithBuffer;
+use crate::WithBuffer;
 use crate::{buf::BoundedBufMut, io::SharedFd, Result};
 use socket2::SockAddr;
 use std::{

diff --git a/src/io/recvmsg.rs b/src/io/recvmsg.rs
@@ -1,6 +1,6 @@
 use crate::runtime::driver::op::{Completable, CqeResult, Op};
 use crate::runtime::CONTEXT;
-use crate::sealed::WithBuffer;
+use crate::WithBuffer;
 use crate::{buf::BoundedBufMut, io::SharedFd, Result};
 use socket2::SockAddr;
 use std::{

diff --git a/src/io/send_to.rs b/src/io/send_to.rs
@@ -2,8 +2,8 @@ use crate::buf::BoundedBuf;
 use crate::io::SharedFd;
 use crate::runtime::driver::op::{Completable, CqeResult, Op};
 use crate::runtime::CONTEXT;
-use crate::sealed::WithBuffer;
 use crate::Result;
+use crate::WithBuffer;
 use socket2::SockAddr;
 use std::io::IoSlice;
 use std::{boxed::Box, io, net::SocketAddr};

diff --git a/src/io/send_zc.rs b/src/io/send_zc.rs
@@ -1,6 +1,6 @@
 use crate::runtime::driver::op::{Completable, CqeResult, MultiCQEFuture, Op, Updateable};
 use crate::runtime::CONTEXT;
-use crate::sealed::WithBuffer;
+use crate::WithBuffer;
 use crate::{buf::BoundedBuf, io::SharedFd, Result};
 use std::io;
 

diff --git a/src/io/write.rs b/src/io/write.rs
@@ -1,4 +1,4 @@
-use crate::sealed::WithBuffer;
+use crate::WithBuffer;
 use crate::{buf::BoundedBuf, io::SharedFd, OneshotOutputTransform, Result, UnsubmittedOneshot};
 use io_uring::cqueue::Entry;
 use std::io;

diff --git a/src/io/write_fixed.rs b/src/io/write_fixed.rs
@@ -2,8 +2,8 @@ use crate::buf::fixed::FixedBuf;
 use crate::buf::BoundedBuf;
 use crate::io::SharedFd;
 use crate::runtime::driver::op::{self, Completable, Op};
-use crate::sealed::WithBuffer;
 use crate::Result;
+use crate::WithBuffer;
 
 use crate::runtime::CONTEXT;
 use std::io;

diff --git a/src/io/writev.rs b/src/io/writev.rs
@@ -1,6 +1,6 @@
 use crate::runtime::driver::op::{Completable, CqeResult, Op};
 use crate::runtime::CONTEXT;
-use crate::sealed::WithBuffer;
+use crate::WithBuffer;
 use crate::{buf::BoundedBuf, io::SharedFd, Result};
 use libc::iovec;
 use std::io;

diff --git a/src/types.rs b/src/types.rs
@@ -61,21 +61,26 @@ impl<B> Error<B> {
     }
 }
 
-pub(super) mod sealed {
-    /// A Specialized trait for mapping over the buffer in both sides of a Result<T,B>
-    pub trait MapResult<B, U> {
-        type Output;
-        fn map_buf(self, f: impl FnOnce(B) -> U) -> Self::Output;
-    }
+mod private {
+    pub trait Sealed {}
+}
+impl<T, B> private::Sealed for std::result::Result<T, B> {}
 
-    /// Adapter trait to convert result::Result<T, E> to crate::Result<T, B> where E can be
-    /// converted to std::io::Error.
-    pub trait WithBuffer<T, B>: Sized {
-        fn with_buffer(self, buf: B) -> T;
-    }
+/// A Specialized trait for mapping over the buffer in both sides of a Result<T,B>
+pub trait MapResult<B, U>: private::Sealed {
+    /// The result type after applying the map operation
+    type Output;
+    /// Apply a function over the buffer on both sides of the result
+    fn map_buf(self, f: impl FnOnce(B) -> U) -> Self::Output;
 }
 
-impl<T, B, U> sealed::MapResult<B, U> for Result<T, B> {
+/// Adapter trait to convert result::Result<T, E> to crate::Result<T, B> where E can be
+/// converted to std::io::Error.
+pub trait WithBuffer<T, B>: private::Sealed {
+    /// Insert a buffer into each side of the result
+    fn with_buffer(self, buf: B) -> T;
+}
+impl<T, B, U> MapResult<B, U> for Result<T, B> {
     type Output = Result<T, U>;
     fn map_buf(self, f: impl FnOnce(B) -> U) -> Self::Output {
         match self {
@@ -86,7 +91,7 @@ impl<T, B, U> sealed::MapResult<B, U> for Result<T, B> {
 }
 
 /// Adaptor implementation for Result<T, E> to Result<T, B>.
-impl<T, B, E> sealed::WithBuffer<crate::Result<T, B>, B> for std::result::Result<T, E>
+impl<T, B, E> WithBuffer<crate::Result<T, B>, B> for std::result::Result<T, E>
 where
     E: Into<std::io::Error>,
 {