fix(runtime): docs of Attacher and remove Attachable

Author: Berrysoft

compio-fs/src/file.rs

@@ -7,7 +7,7 @@ use compio_driver::{
     syscall, AsRawFd,
 };
 use compio_io::{AsyncReadAt, AsyncWriteAt};
-use compio_runtime::{impl_attachable, impl_try_clone, Attacher, Runtime};
+use compio_runtime::{impl_try_clone, Attacher, Runtime};
 #[cfg(unix)]
 use {
     compio_buf::{IoVectoredBuf, IoVectoredBufMut},
@@ -217,6 +217,4 @@ impl AsyncWriteAt for &File {
 
 impl_raw_fd!(File, inner);
 
-impl_attachable!(File, inner);
-
 impl_try_clone!(File, inner);

compio-fs/src/named_pipe.rs

@@ -9,7 +9,7 @@ use std::{ffi::OsStr, io, ptr::null};
 use compio_buf::{BufResult, IoBuf, IoBufMut};
 use compio_driver::{impl_raw_fd, op::ConnectNamedPipe, syscall, AsRawFd, FromRawFd, RawFd};
 use compio_io::{AsyncRead, AsyncReadAt, AsyncWrite, AsyncWriteAt};
-use compio_runtime::{impl_attachable, impl_try_clone, Runtime};
+use compio_runtime::{impl_try_clone, Runtime};
 use widestring::U16CString;
 use windows_sys::Win32::{
     Security::SECURITY_ATTRIBUTES,
@@ -232,8 +232,6 @@ impl AsyncWrite for &NamedPipeServer {
 
 impl_raw_fd!(NamedPipeServer, handle);
 
-impl_attachable!(NamedPipeServer, handle);
-
 impl_try_clone!(NamedPipeServer, handle);
 
 /// A [Windows named pipe] client.
@@ -357,8 +355,6 @@ impl AsyncWrite for &NamedPipeClient {
 
 impl_raw_fd!(NamedPipeClient, handle);
 
-impl_attachable!(NamedPipeClient, handle);
-
 impl_try_clone!(NamedPipeClient, handle);
 
 /// A builder structure for construct a named pipe with named pipe-specific

compio-fs/src/pipe.rs

@@ -9,7 +9,7 @@ use compio_driver::{
     syscall, AsRawFd, FromRawFd, IntoRawFd,
 };
 use compio_io::{AsyncRead, AsyncWrite};
-use compio_runtime::{impl_attachable, impl_try_clone, Runtime};
+use compio_runtime::{impl_try_clone, Runtime};
 
 use crate::File;
 
@@ -383,8 +383,6 @@ impl AsyncWrite for &Sender {
 
 impl_raw_fd!(Sender, file);
 
-impl_attachable!(Sender, file);
-
 impl_try_clone!(Sender, file);
 
 /// Reading end of a Unix pipe.
@@ -508,8 +506,6 @@ impl AsyncRead for &Receiver {
 
 impl_raw_fd!(Receiver, file);
 
-impl_attachable!(Receiver, file);
-
 impl_try_clone!(Receiver, file);
 
 /// Checks if file is a FIFO

compio-net/src/socket.rs

@@ -9,7 +9,7 @@ use compio_driver::{
     },
     AsRawFd,
 };
-use compio_runtime::{impl_attachable, impl_try_clone, Attacher, Runtime};
+use compio_runtime::{impl_try_clone, Attacher, Runtime};
 use socket2::{Domain, Protocol, SockAddr, Socket as Socket2, Type};
 
 #[derive(Debug)]
@@ -206,6 +206,4 @@ impl Socket {
 
 impl_raw_fd!(Socket, socket);
 
-impl_attachable!(Socket, socket);
-
 impl_try_clone!(Socket, socket);

compio-net/src/tcp.rs

@@ -3,7 +3,7 @@ use std::{future::Future, io, net::SocketAddr};
 use compio_buf::{BufResult, IoBuf, IoBufMut, IoVectoredBuf, IoVectoredBufMut};
 use compio_driver::impl_raw_fd;
 use compio_io::{AsyncRead, AsyncWrite};
-use compio_runtime::{impl_attachable, impl_try_clone};
+use compio_runtime::impl_try_clone;
 use socket2::{Protocol, SockAddr, Type};
 
 use crate::{OwnedReadHalf, OwnedWriteHalf, ReadHalf, Socket, ToSocketAddrsAsync, WriteHalf};
@@ -111,8 +111,6 @@ impl TcpListener {
 
 impl_raw_fd!(TcpListener, inner);
 
-impl_attachable!(TcpListener, inner);
-
 impl_try_clone!(TcpListener, inner);
 
 /// A TCP stream between a local and a remote socket.
@@ -279,6 +277,4 @@ impl AsyncWrite for &TcpStream {
 
 impl_raw_fd!(TcpStream, inner);
 
-impl_attachable!(TcpStream, inner);
-
 impl_try_clone!(TcpStream, inner);

compio-net/src/udp.rs

@@ -2,7 +2,7 @@ use std::{future::Future, io, net::SocketAddr};
 
 use compio_buf::{BufResult, IoBuf, IoBufMut, IoVectoredBuf, IoVectoredBufMut};
 use compio_driver::impl_raw_fd;
-use compio_runtime::{impl_attachable, impl_try_clone};
+use compio_runtime::impl_try_clone;
 use socket2::{Protocol, SockAddr, Type};
 
 use crate::{Socket, ToSocketAddrsAsync};
@@ -253,6 +253,4 @@ impl UdpSocket {
 
 impl_raw_fd!(UdpSocket, inner);
 
-impl_attachable!(UdpSocket, inner);
-
 impl_try_clone!(UdpSocket, inner);

compio-net/src/unix.rs

@@ -3,7 +3,7 @@ use std::{future::Future, io, path::Path};
 use compio_buf::{BufResult, IoBuf, IoBufMut, IoVectoredBuf, IoVectoredBufMut};
 use compio_driver::impl_raw_fd;
 use compio_io::{AsyncRead, AsyncWrite};
-use compio_runtime::{impl_attachable, impl_try_clone};
+use compio_runtime::impl_try_clone;
 use socket2::{SockAddr, Type};
 
 use crate::{OwnedReadHalf, OwnedWriteHalf, ReadHalf, Socket, WriteHalf};
@@ -90,8 +90,6 @@ impl UnixListener {
 
 impl_raw_fd!(UnixListener, inner);
 
-impl_attachable!(UnixListener, inner);
-
 impl_try_clone!(UnixListener, inner);
 
 /// A Unix stream between two local sockets on Windows & WSL.
@@ -264,8 +262,6 @@ impl AsyncWrite for &UnixStream {
 
 impl_raw_fd!(UnixStream, inner);
 
-impl_attachable!(UnixStream, inner);
-
 #[cfg(windows)]
 #[inline]
 fn empty_unix_socket() -> SockAddr {

compio-runtime/src/attacher.rs

@@ -30,7 +30,8 @@ pub struct Attacher<S> {
 }
 
 impl<S: AsRawFd> Attacher<S> {
-    /// Create [`Attacher`].
+    /// Create [`Attacher`]. It tries to attach the source, and will return
+    /// [`Err`] if it fails.
     pub fn new(source: S) -> io::Result<Self> {
         let this = Self {
             source,
@@ -41,7 +42,7 @@ impl<S: AsRawFd> Attacher<S> {
     }
 
     /// Attach the source. This method could be called many times, but if the
-    /// action fails, the error will only return once.
+    /// action fails, it will try to attach the source during each call.
     fn attach(&self) -> io::Result<()> {
         let r = Runtime::current();
         let inner = r.inner();
@@ -51,12 +52,6 @@ impl<S: AsRawFd> Attacher<S> {
     }
 }
 
-impl<S> Attachable for Attacher<S> {
-    fn is_attached(&self) -> bool {
-        self.once.get().is_some()
-    }
-}
-
 impl<S: IntoRawFd> IntoRawFd for Attacher<S> {
     fn into_raw_fd(self) -> RawFd {
         self.source.into_raw_fd()
@@ -106,12 +101,6 @@ impl<S> DerefMut for Attacher<S> {
     }
 }
 
-/// Represents an attachable resource to driver.
-pub trait Attachable {
-    /// Check if [`Attachable::attach`] has been called.
-    fn is_attached(&self) -> bool;
-}
-
 /// Duplicatable file or socket.
 pub trait TryClone: Sized {
     /// Duplicate the source.
@@ -151,18 +140,6 @@ impl TryClone for OwnedFd {
     }
 }
 
-#[macro_export]
-#[doc(hidden)]
-macro_rules! impl_attachable {
-    ($t:ty, $inner:ident) => {
-        impl $crate::Attachable for $t {
-            fn is_attached(&self) -> bool {
-                self.$inner.is_attached()
-            }
-        }
-    };
-}
-
 #[macro_export]
 #[doc(hidden)]
 macro_rules! impl_try_clone {