Skip to content

Commit

Permalink
collections: vec_deque: add some notes on how to use VecDeque as a qu…
Browse files Browse the repository at this point in the history
…eue effectively
  • Loading branch information
emberian committed Jul 5, 2015
1 parent 281cfb9 commit f5ea620
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/libcollections/vec_deque.rs
Expand Up @@ -38,6 +38,10 @@ const MINIMUM_CAPACITY: usize = 1; // 2 - 1

/// `VecDeque` is a growable ring buffer, which can be used as a
/// double-ended queue efficiently.
///
/// The "default" usage of this type as a queue is to use `push_back` to add to the queue, and
/// `pop_front` to remove from the queue. `extend` and `append` push onto the back in this manner,
/// and iterating over `VecDeque` goes front to back.
#[stable(feature = "rust1", since = "1.0.0")]
pub struct VecDeque<T> {
// tail and head are pointers into the buffer. Tail always points
Expand Down

0 comments on commit f5ea620

Please sign in to comment.