actix/actix-net
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-net synced 2025-06-27 06:09:02 +02:00
Code Issues Releases Wiki Activity

tweak task and stream docs

Browse Source
This commit is contained in:
Rob Ede
2021-02-20 17:34:04 +00:00
parent 75d7ae3139
commit 7e483cc356
2 changed files with 23 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
actix-rt/src/lib.rs
View File

@ -70,28 +70,27 @@ pub mod signal {
}
pub mod net {
//! TCP/UDP/Unix bindings (Tokio re-exports).
//! TCP/UDP/Unix bindings (mostly Tokio re-exports).
use std::task::{Context, Poll};
use tokio::io::{AsyncRead, AsyncWrite};
pub use tokio::net::UdpSocket;
pub use tokio::net::{TcpListener, TcpStream};
#[cfg(unix)]
pub use tokio::net::{UnixDatagram, UnixListener, UnixStream};
use std::task::{Context, Poll};
use tokio::io::{AsyncRead, AsyncWrite};
/// Trait for generic over tokio stream types and various wrapper types around them.
/// Extension trait over async read+write types that can also signal readiness.
pub trait ActixStream: AsyncRead + AsyncWrite + Unpin + 'static {
/// poll stream and check read readiness of Self.
/// Poll stream and check read readiness of Self.
///
/// See [tokio::net::TcpStream::poll_read_ready] for detail
/// See [tokio::net::TcpStream::poll_read_ready] for detail on intended use.
fn poll_read_ready(&self, cx: &mut Context<'_>) -> Poll<std::io::Result<()>>;
/// poll stream and check write readiness of Self.
/// Poll stream and check write readiness of Self.
///
/// See [tokio::net::TcpStream::poll_write_ready] for detail
/// See [tokio::net::TcpStream::poll_write_ready] for detail on intended use.
fn poll_write_ready(&self, cx: &mut Context<'_>) -> Poll<std::io::Result<()>>;
}