Navigation Menu

Skip to content

Commit

Permalink
Clarify RingBuf documentation.
Browse files Browse the repository at this point in the history
FIxes #22361
  • Loading branch information
steveklabnik committed Feb 17, 2015
1 parent f1bb6c2 commit 0a795c2
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/libcollections/ring_buf.rs
Expand Up @@ -8,9 +8,11 @@
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! This crate implements a double-ended queue with `O(1)` amortized inserts and removals from both
//! ends of the container. It also has `O(1)` indexing like a vector. The contained elements are
//! not required to be copyable, and the queue will be sendable if the contained type is sendable.
//! RingBuf is a double-ended queue, which is implemented with the help of a growing circular buffer.
//!
//! This queue has `O(1)` amortized inserts and removals from both ends of the container. It also
//! has `O(1)` indexing like a vector. The contained elements are not required to be copyable, and
//! the queue will be sendable if the contained type is sendable.

#![stable(feature = "rust1", since = "1.0.0")]

Expand Down

0 comments on commit 0a795c2

Please sign in to comment.