Skip to content

Clarify RingBuf documentation. #22457

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 18, 2015
Merged

Clarify RingBuf documentation. #22457

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/libcollections/ring_buf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
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