Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

io: add get_{ref,mut} methods to AsyncFdReadyGuard and AsyncFdReadyMutGuard. #3807

Merged
merged 3 commits into from Jun 16, 2021
Merged

io: add get_{ref,mut} methods to AsyncFdReadyGuard and AsyncFdReadyMutGuard. #3807

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b42bcb9
io: add get_{ref,mut} methods to AsyncFdReadyGuard and AsyncFdReadyMu…
May 22, 2021
9465943
io: add get_inner{,_mut} methods to AsyncFdReadyGuard and AsyncFdRead…
May 26, 2021
641149d
io: move {AsyncFdReadyGuard,AsyncFdReadyMutGuard}::get_* to the botto…
May 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions tokio/src/io/async_fd.rs
View file
Open in desktop
Expand Up @@ -480,6 +480,16 @@ impl<T: AsRawFd> Drop for AsyncFd<T> {
}

impl<'a, Inner: AsRawFd> AsyncFdReadyGuard<'a, Inner> {
/// Returns a shared reference to the inner [`AsyncFd`].
pub fn get_ref(&self) -> &AsyncFd<Inner> {
self.async_fd
}

/// Returns a shared reference to the backing object of the inner [`AsyncFd`].
pub fn get_inner(&self) -> &Inner {
self.get_ref().get_ref()
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you move the methods to the bottom of the impl block so they don't appear at the top of the documentation?


/// Indicates to tokio that the file descriptor is no longer ready. The
/// internal readiness flag will be cleared, and tokio will wait for the
/// next edge-triggered readiness notification from the OS.
Expand Down Expand Up @@ -543,6 +553,26 @@ impl<'a, Inner: AsRawFd> AsyncFdReadyGuard<'a, Inner> {
}

impl<'a, Inner: AsRawFd> AsyncFdReadyMutGuard<'a, Inner> {
/// Returns a shared reference to the inner [`AsyncFd`].
pub fn get_ref(&self) -> &AsyncFd<Inner> {
self.async_fd
}

/// Returns a mutable reference to the inner [`AsyncFd`].
pub fn get_mut(&mut self) -> &mut AsyncFd<Inner> {
self.async_fd
}

/// Returns a shared reference to the backing object of the inner [`AsyncFd`].
pub fn get_inner(&self) -> &Inner {
self.get_ref().get_ref()
}

/// Returns a mutable reference to the backing object of the inner [`AsyncFd`].
pub fn get_inner_mut(&mut self) -> &mut Inner {
self.get_mut().get_mut()
}

/// Indicates to tokio that the file descriptor is no longer ready. The
/// internal readiness flag will be cleared, and tokio will wait for the
/// next edge-triggered readiness notification from the OS.
Expand Down