itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

io: recommend OwnedFd with AsyncFd (#6821)

Browse Source 
Signed-off-by: Alice Ryhl <aliceryhl@google.com>
This commit is contained in:
Alice Ryhl 2024-09-06 09:52:08 +02:00 committed by GitHub
parent 8046a87a99
commit 91169992b2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
spellcheck.dic
View File

@ -1,4 +1,4 @@
285 286
& &
+ +
< <
@ -99,6 +99,7 @@ errored
EWMA EWMA
expirations expirations
fcntl fcntl
fd
fd's fd's
FIFOs FIFOs
filename filename

7
tokio/src/io/async_fd.rs
View File

@ -21,11 +21,13 @@ use std::task::{ready, Context, Poll};
/// the [`AsyncFd`] is dropped. /// the [`AsyncFd`] is dropped.
/// ///
/// The [`AsyncFd`] takes ownership of an arbitrary object to represent the IO /// 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 /// descriptor when it is dropped, avoiding resource leaks and ensuring that the
/// [`AsyncFd`] can clean up the registration before closing the file descriptor. /// [`AsyncFd`] can clean up the registration before closing the file descriptor.
/// The [`AsyncFd::into_inner`] function can be used to extract the inner object /// 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 /// The inner object is required to implement [`AsRawFd`]. This file descriptor
/// must not change while [`AsyncFd`] owns the inner object, i.e. the /// must not change while [`AsyncFd`] owns the inner object, i.e. the
@ -175,6 +177,7 @@ use std::task::{ready, Context, Poll};
/// [`TcpStream::poll_read_ready`]: struct@crate::net::TcpStream /// [`TcpStream::poll_read_ready`]: struct@crate::net::TcpStream
/// [`AsyncRead`]: trait@crate::io::AsyncRead /// [`AsyncRead`]: trait@crate::io::AsyncRead
/// [`AsyncWrite`]: trait@crate::io::AsyncWrite /// [`AsyncWrite`]: trait@crate::io::AsyncWrite
/// [`OwnedFd`]: struct@std::os::fd::OwnedFd
pub struct AsyncFd<T: AsRawFd> { pub struct AsyncFd<T: AsRawFd> {
registration: Registration, registration: Registration,
// The inner value is always present. the Option is required for `drop` and `into_inner`. // The inner value is always present. the Option is required for `drop` and `into_inner`.