gitea-mirror/rosenpass
1
0
Fork 0
mirror of https://github.com/rosenpass/rosenpass.git synced 2026-02-27 22:13:12 -08:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Adjust docstrings for the mio module

Browse Source
This commit is contained in:
Philipp Dresselmann
2024-12-16 22:28:07 +01:00
parent ea233bf137
commit a537eb3e1b
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
util/src/mio/mio.rs
View File

@@ -20,7 +20,7 @@ pub mod interest {
pub const RW: Interest = R.add(W); pub const RW: Interest = R.add(W);
} }
/// Extension trait providing additional functionality for Unix listener /// Extension trait providing additional functionality for a Unix listener
/// ///
/// # Example /// # Example
/// ///
@@ -61,6 +61,7 @@ pub mod interest {
/// ``` /// ```
pub trait UnixListenerExt: Sized { pub trait UnixListenerExt: Sized {
/// Creates a new Unix listener by claiming ownership of a raw file descriptor /// Creates a new Unix listener by claiming ownership of a raw file descriptor
/// (see [fd::claim_fd](crate::fd::claim_fd))
fn claim_fd(fd: RawFd) -> anyhow::Result<Self>; fn claim_fd(fd: RawFd) -> anyhow::Result<Self>;
} }
@@ -74,15 +75,17 @@ impl UnixListenerExt for UnixListener {
} }
} }
/// Extension trait providing additional functionality for Unix streams /// Extension trait providing additional functionality for a Unix stream
pub trait UnixStreamExt: Sized { pub trait UnixStreamExt: Sized {
/// Creates a new Unix stream from an owned file descriptor /// Creates a new Unix stream from an owned file descriptor
fn from_fd(fd: OwnedFd) -> anyhow::Result<Self>; fn from_fd(fd: OwnedFd) -> anyhow::Result<Self>;
/// Claims ownership of a raw file descriptor and creates a new Unix stream /// Claims ownership of a raw file descriptor and creates a new Unix stream
/// (see [fd::claim_fd](crate::fd::claim_fd))
fn claim_fd(fd: RawFd) -> anyhow::Result<Self>; fn claim_fd(fd: RawFd) -> anyhow::Result<Self>;
/// Claims ownership of a raw file descriptor in place and creates a new Unix stream /// Claims ownership of a raw file descriptor in place and creates a new Unix stream
/// (see [fd::claim_fd_inplace](crate::fd::claim_fd_inplace))
fn claim_fd_inplace(fd: RawFd) -> anyhow::Result<Self>; fn claim_fd_inplace(fd: RawFd) -> anyhow::Result<Self>;
} }