Struct CircularBuffer 

pub struct CircularBuffer<T> { /* private fields */ }

Fixed size circular/cyclic/ring buffer

A FIFO (first in, first out) queue. It cannot represent an empty buffer.

When constructed, the internal list must not be empty, and cannot contain invalid (e.g. uninitialized) elements.

Implementations

impl<T> CircularBuffer<T>

pub fn len(&self) -> usize

Returns the number of elements (before starting to loop around).

pub fn queue(&mut self, elem: T) -> T

Enqueues (push at beginning) the given element at the beginning of the buffer Dequeues (pop at end) the last element and returns it This keeps the the buffer length

pub fn set_first(&mut self, index: usize)

Sets the offset for the first element, relative to the currently first element When index is out of range, it loops around

pub fn get(&self, index: usize) -> &T

Returns a reference to the element at the given index When index is out of range, it loops around

pub fn get_mut(&mut self, index: usize) -> &mut T

Returns a mutable reference to the element at the given index When index is out of range, it loops around

pub fn swap_internal(&mut self, a: usize, b: usize)

Swaps the two elements at the given indices a and b. When a or b are out of range, they loop around

pub fn swap(&mut self, index: usize, elem: T) -> T

Swaps the element at the given index with the specifiied new one. When a or b are out of range, they loop around

pub fn iter_circular<'s>(&'s self) -> IterCircular<'s, T>

Returns an iterator over the buffer looping around at the end. This creates a never ending iterator

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

Returns an iterator over the buffer without looping around.

pub unsafe fn from_raw_parts(list: Box<[T]>, first: usize) -> Self

Constructs the structure from its raw components

Unsafety

This function is unsafe as there is no guarantee that first < list.len(), nor whether list is non-empty.

pub fn into_raw_parts(self) -> (Box<[T]>, usize)

Deconstructs the structure into its raw components

Trait Implementations

impl<T: Clone> Clone for CircularBuffer<T>

fn clone(&self) -> CircularBuffer<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> From<Box<[T]>> for CircularBuffer<T>

fn from(l: Box<[T]>) -> Self

Converts to this type from the input type.

impl<T> From<Vec<T>> for CircularBuffer<T>

fn from(vec: Vec<T>) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for CircularBuffer<T>

fn from_iter<I>(i: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl<T: Hash> Hash for CircularBuffer<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: PartialEq> PartialEq for CircularBuffer<T>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for CircularBuffer<T>

impl<T> StructuralPartialEq for CircularBuffer<T>