Struct polars_utils::fixedringbuffer::FixedRingBuffer

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

A ring-buffer with a size determined at creation-time

This makes it perfectly suited for buffers that produce and consume at different speeds.

Implementations

impl<T> FixedRingBuffer<T>

pub fn new(capacity: usize) -> Self

pub const fn len(&self) -> usize

pub const fn capacity(&self) -> usize

pub const fn remaining_capacity(&self) -> usize

pub const fn is_empty(&self) -> bool

pub const fn is_full(&self) -> bool

pub fn as_slices(&self) -> (&[T], &[T])

Get a reference to all elements in the form of two slices.

These are in the listed in the order of being pushed into the buffer.

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

Pop an item at the front of the FixedRingBuffer

pub fn push(&mut self, value: T) -> Option<()>

Push an item into the FixedRingBuffer

Returns None if there is no more space

impl<T: Copy> FixedRingBuffer<T>

pub fn fill_repeat(&mut self, value: T, num: usize) -> usize

Add at most num items of value into the FixedRingBuffer

This returns the amount of items actually added.

Trait Implementations

impl<T> Drop for FixedRingBuffer<T>

fn drop(&mut self)

Executes the destructor for this type.