Skip to main content

Buffer

Struct Buffer 

Source
pub struct Buffer<T> {
    pub capacity: usize,
    pub values: Vec<T>,
}
Expand description

A bounded FIFO connective.

Fields§

§capacity: usize

Maximum number of retained values.

§values: Vec<T>

Retained values in FIFO order.

Implementations§

Source§

impl<T> Buffer<T>

Source

pub fn new(capacity: usize) -> Self

Construct an empty FIFO with a fixed capacity.

Source

pub fn capacity(&self) -> usize

Fixed FIFO capacity.

Source

pub fn len(&self) -> usize

Number of retained values.

Source

pub fn is_empty(&self) -> bool

Whether no values are retained.

Source

pub fn is_full(&self) -> bool

Whether the FIFO is at capacity.

Source

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

Push one value, returning it unchanged when the FIFO is full.

§Errors

Returns the supplied value when the buffer is full.

Source

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

Remove and return the oldest retained value.

Source§

impl<T: ValueEq + Copy> Buffer<T>

Source

pub fn contains(&self, value: T) -> bool

Query retained membership through the Buffer owner.

Source

pub fn push_unique(&mut self, value: T) -> bool

Append a value only when it is absent and capacity remains.

Source

pub fn remove_value(&mut self, value: T) -> bool

Remove one distinct retained value wherever it occurs.

Trait Implementations§

Source§

impl<T: Debug> Debug for Buffer<T>

Source§

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Buffer<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for Buffer<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for Buffer<T>
where Vec<T>: Send,

§

impl<T> Sync for Buffer<T>
where Vec<T>: Sync,

§

impl<T> Unpin for Buffer<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for Buffer<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for Buffer<T>
where Vec<T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.