Struct RingBuffer

pub(super) struct RingBuffer<T> {
    data: VecDeque<T>,
    offset: usize,
}

A view onto a finite range of an infinitely long sequence of T.

The Ts are indexed 0..infinity. A RingBuffer begins as a view of elements 0..0 (i.e. nothing). The user of the RingBuffer advances its left and right position independently, although only in the positive direction, and only with left <= right at all times.

Holding a RingBuffer whose view is elements left..right gives the ability to use Index and IndexMut to access elements i in the infinitely long queue for which left <= i < right.

Fields

data: VecDeque<T>

offset: usize

Implementations

impl<T> RingBuffer<T>

pub(super) fn new() -> Self

pub(super) fn is_empty(&self) -> bool

pub(super) fn push(&mut self, value: T) -> usize

pub(super) fn clear(&mut self)

pub(super) fn index_of_first(&self) -> usize

pub(super) fn first(&self) -> Option<&T>

pub(super) fn first_mut(&mut self) -> Option<&mut T>

pub(super) fn pop_first(&mut self) -> Option<T>

pub(super) fn last(&self) -> Option<&T>

pub(super) fn last_mut(&mut self) -> Option<&mut T>

Trait Implementations

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.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes