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

tcp: Update listener docs (#2276)

Browse Source 
* Update listener docs
* re-wrap text and add links
This commit is contained in:
Akshay Narayan 2020-02-26 15:16:13 -05:00 committed by GitHub
parent 8b7ea0ff5c
commit d44ce338af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tokio/src/net/tcp/listener.rs
View File

@ -12,10 +12,10 @@ use std::task::{Context, Poll};
cfg_tcp! {
/// A TCP socket server, listening for connections.
///
/// Also implements a stream over the connections being received on this listener.
///
/// The stream will never return `None` and will also not yield the peer's
/// `SocketAddr` structure. Iterating over it is equivalent to calling accept in a loop.
/// You can accept a new connection by using the [`accept`](`TcpListener::accept`) method. Alternatively `TcpListener`
/// implements the [`Stream`](`crate::stream::Stream`) trait, which allows you to use the listener in places that want a
/// stream. The stream will never return `None` and will also not yield the peer's `SocketAddr` structure. Iterating over
/// it is equivalent to calling accept in a loop.
///
/// # Errors
///
@ -27,7 +27,7 @@ cfg_tcp! {
///
/// # Examples
///
/// Using [`TcpListener::accept`]:
/// Using `accept`:
/// ```no_run
/// use tokio::net::TcpListener;
///
@ -278,6 +278,8 @@ impl TcpListener {
/// Returns a stream over the connections being received on this listener.
///
/// Note that `TcpListener` also directly implements `Stream`.
///
/// The returned stream will never return `None` and will also not yield the
/// peer's `SocketAddr` structure. Iterating over it is equivalent to
/// calling accept in a loop.

10
tokio/src/net/unix/listener.rs
View File

@ -15,10 +15,10 @@ use std::task::{Context, Poll};
cfg_uds! {
/// A Unix socket which can accept connections from other Unix sockets.
///
/// Also implements a stream over the connections being received on this listener.
///
/// The stream will never return `None` and will also not yield the peer's
/// `SocketAddr` structure. Iterating over it is equivalent to calling accept in a loop.
/// You can accept a new connection by using the [`accept`](`UnixListener::accept`) method. Alternatively `UnixListener`
/// implements the [`Stream`](`crate::stream::Stream`) trait, which allows you to use the listener in places that want a
/// stream. The stream will never return `None` and will also not yield the peer's `SocketAddr` structure. Iterating over
/// it is equivalent to calling accept in a loop.
///
/// # Errors
///
@ -137,6 +137,8 @@ impl UnixListener {
/// Returns a stream over the connections being received on this listener.
///
/// Note that `UnixListener` also directly implements `Stream`.
///
/// The returned stream will never return `None` and will also not yield the
/// peer's `SocketAddr` structure. Iterating over it is equivalent to
/// calling accept in a loop.