Struct ringbuffer::RingBuffer

pub struct RingBuffer<T> { /* fields omitted */ }

The RingBuffer struct.

Example

use ringbuffer::RingBuffer;

let mut buffer = RingBuffer::with_capacity(2);

// First entry of the buffer is now 5.
buffer.push(5);

assert_eq!(buffer[0], 5);

// Second entry is now 42.
buffer.push(42);

// Because capacity is reached the next push will be the first item of the buffer.
buffer.push(1);
assert_eq!(buffer[0], 1);

Methods

impl<T> RingBuffer<T>

pub fn with_capacity(cap: usize) -> Self

Creates a RingBuffer with a certain capacity.

pub fn new() -> Self

Creates a RingBuffer with a capacity of RINGBUFFER_DEFAULT_CAPACITY.

pub fn len(&self) -> usize

Returns the length of the internal buffer.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty, some value between 0 and capacity.

pub fn clear(&mut self)

Empties the buffer.

pub fn capacity(&self) -> usize

Returns the capacity of the buffer.

pub fn push(&mut self, e: T)

Pushes a value onto the buffer. Cycles around if capacity is reached.

pub fn peek(&self) -> Option<&T>

Returns the value at the current index. This is the value that will be overwritten by the next push.

pub fn iter(&self) -> Iter<T>

Creates an iterator over the buffer starting from the latest push.

pub fn iter_mut(&mut self) -> IterMut<T>

Creates a mutable iterator over the buffer starting from the latest push.

pub fn to_vec(&self) -> Vec<T> where
    T: Copy, 

Converts the buffer to an vector.

Trait Implementations

impl<T: Debug> Debug for RingBuffer<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Default for RingBuffer<T>

fn default() -> Self

Creates a buffer with a capacity of RINGBUFFER_DEFAULT_CAPACITY.

impl<T> Index<usize> for RingBuffer<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for RingBuffer<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq> PartialEq<RingBuffer<T>> for RingBuffer<T>

fn eq(&self, other: &RingBuffer<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RingBuffer<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for RingBuffer<T>