Struct std::collections::RingBufStable
[-]
[+]
[src]
pub struct RingBuf<T> {
// some fields omitted
}RingBuf is a circular buffer, which can be used as a double-ended queue efficiently.
Methods
impl<T> RingBuf<T>
fn new() -> RingBuf<T>
Creates an empty RingBuf.
fn with_capacity(n: usize) -> RingBuf<T>
Creates an empty RingBuf with space for at least n elements.
fn get(&self, i: usize) -> Option<&T>
Retrieves an element in the RingBuf by index.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); assert_eq!(buf.get(1).unwrap(), &4); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); assert_eq!(buf.get(1).unwrap(), &4);
fn get_mut(&mut self, i: usize) -> Option<&mut T>
Retrieves an element in the RingBuf mutably by index.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); match buf.get_mut(1) { None => {} Some(elem) => { *elem = 7; } } assert_eq!(buf[1], 7); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); match buf.get_mut(1) { None => {} Some(elem) => { *elem = 7; } } assert_eq!(buf[1], 7);
fn swap(&mut self, i: usize, j: usize)
Swaps elements at indices i and j.
i and j may be equal.
Fails if there is no element with either index.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); buf.swap(0, 2); assert_eq!(buf[0], 5); assert_eq!(buf[2], 3); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(3i); buf.push_back(4); buf.push_back(5); buf.swap(0, 2); assert_eq!(buf[0], 5); assert_eq!(buf[2], 3);
fn capacity(&self) -> usize
Returns the number of elements the RingBuf can hold without
reallocating.
Examples
fn main() { use std::collections::RingBuf; let buf: RingBuf<int> = RingBuf::with_capacity(10); assert!(buf.capacity() >= 10); }use std::collections::RingBuf; let buf: RingBuf<int> = RingBuf::with_capacity(10); assert!(buf.capacity() >= 10);
fn reserve_exact(&mut self, additional: usize)
Reserves the minimum capacity for exactly additional more elements to be inserted in the
given RingBuf. Does nothing if the capacity is already sufficient.
Note that the allocator may give the collection more space than it requests. Therefore
capacity can not be relied upon to be precisely minimal. Prefer reserve if future
insertions are expected.
Panics
Panics if the new capacity overflows uint.
Examples
fn main() { use std::collections::RingBuf; let mut buf: RingBuf<int> = vec![1].into_iter().collect(); buf.reserve_exact(10); assert!(buf.capacity() >= 11); }use std::collections::RingBuf; let mut buf: RingBuf<int> = vec![1].into_iter().collect(); buf.reserve_exact(10); assert!(buf.capacity() >= 11);
fn reserve(&mut self, additional: usize)
Reserves capacity for at least additional more elements to be inserted in the given
Ringbuf. The collection may reserve more space to avoid frequent reallocations.
Panics
Panics if the new capacity overflows uint.
Examples
fn main() { use std::collections::RingBuf; let mut buf: RingBuf<int> = vec![1].into_iter().collect(); buf.reserve(10); assert!(buf.capacity() >= 11); }use std::collections::RingBuf; let mut buf: RingBuf<int> = vec![1].into_iter().collect(); buf.reserve(10); assert!(buf.capacity() >= 11);
fn shrink_to_fit(&mut self)
Shrinks the capacity of the ringbuf as much as possible.
It will drop down as close as possible to the length but the allocator may still inform the ringbuf that there is space for a few more elements.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::with_capacity(15); buf.extend(range(0u, 4)); assert_eq!(buf.capacity(), 15); buf.shrink_to_fit(); assert!(buf.capacity() >= 4); }use std::collections::RingBuf; let mut buf = RingBuf::with_capacity(15); buf.extend(range(0u, 4)); assert_eq!(buf.capacity(), 15); buf.shrink_to_fit(); assert!(buf.capacity() >= 4);
fn truncate(&mut self, len: usize)
Shorten a ringbuf, dropping excess elements from the back.
If len is greater than the ringbuf's current length, this has no
effect.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(15); buf.truncate(1); assert_eq!(buf.len(), 1); assert_eq!(Some(&5), buf.get(0)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(15); buf.truncate(1); assert_eq!(buf.len(), 1); assert_eq!(Some(&5), buf.get(0));
fn iter(&self) -> Iter<T>
Returns a front-to-back iterator.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(3); buf.push_back(4); let b: &[_] = &[&5, &3, &4]; assert_eq!(buf.iter().collect::<Vec<&int>>().as_slice(), b); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(3); buf.push_back(4); let b: &[_] = &[&5, &3, &4]; assert_eq!(buf.iter().collect::<Vec<&int>>().as_slice(), b);
fn iter_mut(&'a mut self) -> IterMut<'a, T>
Returns a front-to-back iterator that returns mutable references.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(3); buf.push_back(4); for num in buf.iter_mut() { *num = *num - 2; } let b: &[_] = &[&mut 3, &mut 1, &mut 2]; assert_eq!(&buf.iter_mut().collect::<Vec<&mut int>>()[], b); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(3); buf.push_back(4); for num in buf.iter_mut() { *num = *num - 2; } let b: &[_] = &[&mut 3, &mut 1, &mut 2]; assert_eq!(&buf.iter_mut().collect::<Vec<&mut int>>()[], b);
fn into_iter(self) -> IntoIter<T>
Consumes the list into an iterator yielding elements by value.
fn as_slices(&'a self) -> (&'a [T], &'a [T])
Returns a pair of slices which contain, in order, the contents of the
RingBuf.
fn as_mut_slices(&'a mut self) -> (&'a mut [T], &'a mut [T])
Returns a pair of slices which contain, in order, the contents of the
RingBuf.
fn len(&self) -> usize
Returns the number of elements in the RingBuf.
Examples
fn main() { use std::collections::RingBuf; let mut v = RingBuf::new(); assert_eq!(v.len(), 0); v.push_back(1i); assert_eq!(v.len(), 1); }use std::collections::RingBuf; let mut v = RingBuf::new(); assert_eq!(v.len(), 0); v.push_back(1i); assert_eq!(v.len(), 1);
fn is_empty(&self) -> bool
Returns true if the buffer contains no elements
Examples
fn main() { use std::collections::RingBuf; let mut v = RingBuf::new(); assert!(v.is_empty()); v.push_front(1i); assert!(!v.is_empty()); }use std::collections::RingBuf; let mut v = RingBuf::new(); assert!(v.is_empty()); v.push_front(1i); assert!(!v.is_empty());
fn drain(&mut self) -> Drain<T>
Creates a draining iterator that clears the RingBuf and iterates over
the removed items from start to end.
Examples
fn main() { use std::collections::RingBuf; let mut v = RingBuf::new(); v.push_back(1i); assert_eq!(v.drain().next(), Some(1)); assert!(v.is_empty()); }use std::collections::RingBuf; let mut v = RingBuf::new(); v.push_back(1i); assert_eq!(v.drain().next(), Some(1)); assert!(v.is_empty());
fn clear(&mut self)
Clears the buffer, removing all values.
Examples
fn main() { use std::collections::RingBuf; let mut v = RingBuf::new(); v.push_back(1i); v.clear(); assert!(v.is_empty()); }use std::collections::RingBuf; let mut v = RingBuf::new(); v.push_back(1i); v.clear(); assert!(v.is_empty());
fn front(&self) -> Option<&T>
Provides a reference to the front element, or None if the sequence is
empty.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.front(), None); d.push_back(1i); d.push_back(2i); assert_eq!(d.front(), Some(&1i)); }use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.front(), None); d.push_back(1i); d.push_back(2i); assert_eq!(d.front(), Some(&1i));
fn front_mut(&mut self) -> Option<&mut T>
Provides a mutable reference to the front element, or None if the
sequence is empty.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.front_mut(), None); d.push_back(1i); d.push_back(2i); match d.front_mut() { Some(x) => *x = 9i, None => (), } assert_eq!(d.front(), Some(&9i)); }use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.front_mut(), None); d.push_back(1i); d.push_back(2i); match d.front_mut() { Some(x) => *x = 9i, None => (), } assert_eq!(d.front(), Some(&9i));
fn back(&self) -> Option<&T>
Provides a reference to the back element, or None if the sequence is
empty.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.back(), None); d.push_back(1i); d.push_back(2i); assert_eq!(d.back(), Some(&2i)); }use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.back(), None); d.push_back(1i); d.push_back(2i); assert_eq!(d.back(), Some(&2i));
fn back_mut(&mut self) -> Option<&mut T>
Provides a mutable reference to the back element, or None if the
sequence is empty.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.back(), None); d.push_back(1i); d.push_back(2i); match d.back_mut() { Some(x) => *x = 9i, None => (), } assert_eq!(d.back(), Some(&9i)); }use std::collections::RingBuf; let mut d = RingBuf::new(); assert_eq!(d.back(), None); d.push_back(1i); d.push_back(2i); match d.back_mut() { Some(x) => *x = 9i, None => (), } assert_eq!(d.back(), Some(&9i));
fn pop_front(&mut self) -> Option<T>
Removes the first element and returns it, or None if the sequence is
empty.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); d.push_back(1i); d.push_back(2i); assert_eq!(d.pop_front(), Some(1i)); assert_eq!(d.pop_front(), Some(2i)); assert_eq!(d.pop_front(), None); }use std::collections::RingBuf; let mut d = RingBuf::new(); d.push_back(1i); d.push_back(2i); assert_eq!(d.pop_front(), Some(1i)); assert_eq!(d.pop_front(), Some(2i)); assert_eq!(d.pop_front(), None);
fn push_front(&mut self, t: T)
Inserts an element first in the sequence.
Examples
fn main() { use std::collections::RingBuf; let mut d = RingBuf::new(); d.push_front(1i); d.push_front(2i); assert_eq!(d.front(), Some(&2i)); }use std::collections::RingBuf; let mut d = RingBuf::new(); d.push_front(1i); d.push_front(2i); assert_eq!(d.front(), Some(&2i));
fn push_back(&mut self, t: T)
Appends an element to the back of a buffer
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(1i); buf.push_back(3); assert_eq!(3, *buf.back().unwrap()); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(1i); buf.push_back(3); assert_eq!(3, *buf.back().unwrap());
fn pop_back(&mut self) -> Option<T>
Removes the last element from a buffer and returns it, or None if
it is empty.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.pop_back(), None); buf.push_back(1i); buf.push_back(3); assert_eq!(buf.pop_back(), Some(3)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.pop_back(), None); buf.push_back(1i); buf.push_back(3); assert_eq!(buf.pop_back(), Some(3));
fn swap_back_remove(&mut self, index: usize) -> Option<T>
Removes an element from anywhere in the ringbuf and returns it, replacing it with the last element.
This does not preserve ordering, but is O(1).
Returns None if index is out of bounds.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.swap_back_remove(0), None); buf.push_back(5i); buf.push_back(99); buf.push_back(15); buf.push_back(20); buf.push_back(10); assert_eq!(buf.swap_back_remove(1), Some(99)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.swap_back_remove(0), None); buf.push_back(5i); buf.push_back(99); buf.push_back(15); buf.push_back(20); buf.push_back(10); assert_eq!(buf.swap_back_remove(1), Some(99));
fn swap_front_remove(&mut self, index: usize) -> Option<T>
Removes an element from anywhere in the ringbuf and returns it, replacing it with the first element.
This does not preserve ordering, but is O(1).
Returns None if index is out of bounds.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.swap_front_remove(0), None); buf.push_back(15i); buf.push_back(5); buf.push_back(10); buf.push_back(99); buf.push_back(20i); assert_eq!(buf.swap_front_remove(3), Some(99)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); assert_eq!(buf.swap_front_remove(0), None); buf.push_back(15i); buf.push_back(5); buf.push_back(10); buf.push_back(99); buf.push_back(20i); assert_eq!(buf.swap_front_remove(3), Some(99));
fn insert(&mut self, i: usize, t: T)
Inserts an element at position i within the ringbuf. Whichever
end is closer to the insertion point will be moved to make room,
and all the affected elements will be moved to new positions.
Panics
Panics if i is greater than ringbuf's length
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(10i); buf.push_back(12); buf.insert(1,11); assert_eq!(Some(&11), buf.get(1)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(10i); buf.push_back(12); buf.insert(1,11); assert_eq!(Some(&11), buf.get(1));
fn remove(&mut self, i: usize) -> Option<T>
Removes and returns the element at position i from the ringbuf.
Whichever end is closer to the removal point will be moved to make
room, and all the affected elements will be moved to new positions.
Returns None if i is out of bounds.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(12i); buf.push_back(15); buf.remove(2); assert_eq!(Some(&15), buf.get(2)); }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(12i); buf.push_back(15); buf.remove(2); assert_eq!(Some(&15), buf.get(2));
impl<T: Clone> RingBuf<T>
fn resize(&mut self, new_len: usize, value: T)
Modifies the ringbuf in-place so that len() is equal to new_len,
either by removing excess elements or by appending copies of a value to the back.
Examples
fn main() { use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(15); buf.resize(2, 0); buf.resize(6, 20); for (a, b) in [5, 10, 20, 20, 20, 20].iter().zip(buf.iter()) { assert_eq!(a, b); } }use std::collections::RingBuf; let mut buf = RingBuf::new(); buf.push_back(5i); buf.push_back(10i); buf.push_back(15); buf.resize(2, 0); buf.resize(6, 20); for (a, b) in [5, 10, 20, 20, 20, 20].iter().zip(buf.iter()) { assert_eq!(a, b); }