Skip to content

Commit

Permalink
io: recommend OwnedFd with AsyncFd (#6821)
Browse files Browse the repository at this point in the history
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
  • Loading branch information
Darksonn authored Sep 6, 2024
1 parent 8046a87 commit 9116999
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
3 changes: 2 additions & 1 deletion spellcheck.dic
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
285
286
&
+
<
Expand Down Expand Up @@ -99,6 +99,7 @@ errored
EWMA
expirations
fcntl
fd
fd's
FIFOs
filename
Expand Down
7 changes: 5 additions & 2 deletions tokio/src/io/async_fd.rs
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ use std::task::{ready, Context, Poll};
/// the [`AsyncFd`] is dropped.
///
/// The [`AsyncFd`] takes ownership of an arbitrary object to represent the IO
/// object. It is intended that this object will handle closing the file
/// object. It is intended that the inner object will handle closing the file
/// descriptor when it is dropped, avoiding resource leaks and ensuring that the
/// [`AsyncFd`] can clean up the registration before closing the file descriptor.
/// The [`AsyncFd::into_inner`] function can be used to extract the inner object
/// to retake control from the tokio IO reactor.
/// to retake control from the tokio IO reactor. The [`OwnedFd`] type is often
/// used as the inner object, as it is the simplest type that closes the fd on
/// drop.
///
/// The inner object is required to implement [`AsRawFd`]. This file descriptor
/// must not change while [`AsyncFd`] owns the inner object, i.e. the
Expand Down Expand Up @@ -175,6 +177,7 @@ use std::task::{ready, Context, Poll};
/// [`TcpStream::poll_read_ready`]: struct@crate::net::TcpStream
/// [`AsyncRead`]: trait@crate::io::AsyncRead
/// [`AsyncWrite`]: trait@crate::io::AsyncWrite
/// [`OwnedFd`]: struct@std::os::fd::OwnedFd
pub struct AsyncFd<T: AsRawFd> {
registration: Registration,
// The inner value is always present. the Option is required for `drop` and `into_inner`.
Expand Down

0 comments on commit 9116999

Please sign in to comment.