Don't re-export everything from buf module

This commit is contained in:
Carl Lerche
2017-02-28 17:09:43 -08:00
parent 87160b6232
commit f7f8d6c9ef
2 changed files with 26 additions and 3 deletions
+18
View File
@@ -1,3 +1,21 @@
//! Utilities for working with buffers.
//!
//! A buffer is any structure that contains a sequence of bytes. The bytes may
//! or may not be stored in contiguous memory. This module contains traits used
//! to abstract over buffers as well as utilities for working with buffer types.
//!
//! # `Buf`, `BufMut`
//!
//! These are the two foundational traits for abstractly working with buffers.
//! They can be thought as iterators for byte structures. They offer additional
//! performance over `Iterator` by providing an API optimized for byte slices.
//!
//! See [`Buf`] and [`BufMut`] for more details.
//!
//! [rope]: https://en.wikipedia.org/wiki/Rope_(data_structure)
//! [`Buf`]: trait.Buf.html
//! [`BufMut`]: trait.BufMut.html
use std::{cmp, io, usize};
mod buf;
+8 -3
View File
@@ -73,17 +73,22 @@
extern crate byteorder;
mod buf;
mod bytes;
pub mod buf;
pub use buf::{
Buf,
BufMut,
IntoBuf,
};
#[deprecated(since = "0.4.1", note = "moved to `buf` module")]
#[doc(hidden)]
pub use buf::{
Source,
Reader,
Writer,
Take,
};
mod bytes;
pub use bytes::{Bytes, BytesMut};
pub use byteorder::{ByteOrder, BigEndian, LittleEndian};