1
0
mirror of https://github.com/fafhrd91/actix-net synced 2024-12-04 20:31:56 +01:00
actix-net/src/codec/mod.rs

35 lines
1.2 KiB
Rust
Raw Normal View History

2018-10-05 22:07:09 +02:00
//! Utilities for encoding and decoding frames.
//!
//! 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`]: #
//! [`AsyncWrite`]: #
//! [`Sink`]: #
//! [`Stream`]: #
//! [transports]: #
#![deny(missing_docs, missing_debug_implementations, warnings)]
#![doc(hidden, html_root_url = "https://docs.rs/tokio-codec/0.1.0")]
// _tokio_codec are the items that belong in the `tokio_codec` crate. However,
// because we need to maintain backward compatibility until the next major
// breaking change, they are defined here. When the next breaking change comes,
// they should be moved to the
// `tokio_codec` crate and become independent.
//
// The primary reason we can't move these to `tokio-codec` now is because,
// again for backward compatibility reasons, we need to keep `Decoder` and
// `Encoder` in tokio_io::codec. And `Decoder` and `Encoder` needs to reference
// `Framed`. So they all still need
// to still be in the same module.
mod framed;
mod framed_read;
mod framed_write;
pub use self::framed::{Framed, FramedParts};
pub use self::framed_read::FramedRead;
pub use self::framed_write::FramedWrite;