diff options
| author | Geoff Shannon <geoffpshannon@gmail.com> | 2020-05-14 07:51:55 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-14 16:51:55 +0200 |
| commit | b44ab273597d3757b5b50eed95c4f8890fa54e42 (patch) | |
| tree | 34192a726cd72679bead33376d2f8bed86d67f26 /tokio-util | |
| parent | 02661ba30aed5d02e142212a323103d1bf84557b (diff) | |
docs: improve discoverability of codec module (#2523)
Diffstat (limited to 'tokio-util')
| -rw-r--r-- | tokio-util/src/codec/mod.rs | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/tokio-util/src/codec/mod.rs b/tokio-util/src/codec/mod.rs index 96e9f9f9..e89aa7c9 100644 --- a/tokio-util/src/codec/mod.rs +++ b/tokio-util/src/codec/mod.rs @@ -1,8 +1,13 @@ -//! Utilities for encoding and decoding frames. +//! Adaptors from AsyncRead/AsyncWrite to Stream/Sink //! -//! Contains adapters to go from streams of bytes, [`AsyncRead`] and -//! [`AsyncWrite`], to framed streams implementing [`Sink`] and [`Stream`]. -//! Framed streams are also known as transports. +//! Raw I/O objects work with byte sequences, but higher-level code +//! usually wants to batch these into meaningful chunks, called +//! "frames". +//! +//! This module contains adapters to go from streams of bytes, +//! [`AsyncRead`] and [`AsyncWrite`], to framed streams implementing +//! [`Sink`] and [`Stream`]. Framed streams are also known as +//! transports. //! //! [`AsyncRead`]: tokio::io::AsyncRead //! [`AsyncWrite`]: tokio::io::AsyncWrite |