Skip to content

Commit

Permalink
doc: minor: Fix TokioIo doc
Browse files Browse the repository at this point in the history
The TokioIo docs are confusing when a user intends to use it for
adapting a hyper IO trait impl to a Tokio IO trait impl. This commit
updates the TokioIo docs to make clear that it is a bidirectional
adapter between Tokio's and hyper's IO traits.
  • Loading branch information
MaxFangX authored and seanmonstar committed Apr 12, 2024
1 parent 564ae12 commit a566eb0
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/rt/tokio.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ use pin_project_lite::pin_project;
pub struct TokioExecutor {}

pin_project! {
/// A wrapping implementing hyper IO traits for a type that
/// implements Tokio's IO traits.
/// A wrapper that implements Tokio's IO traits for an inner type that
/// implements hyper's IO traits, or vice versa (implements hyper's IO
/// traits for a type that implements Tokio's IO traits).
#[derive(Debug)]
pub struct TokioIo<T> {
#[pin]
Expand Down Expand Up @@ -62,7 +63,7 @@ impl TokioExecutor {
// ==== impl TokioIo =====

impl<T> TokioIo<T> {
/// Wrap a type implementing Tokio's IO traits.
/// Wrap a type implementing Tokio's or hyper's IO traits.
pub fn new(inner: T) -> Self {
Self { inner }
}
Expand Down

0 comments on commit a566eb0

Please sign in to comment.