[−][src]Struct amethyst_utils::circular_buffer::CircularBuffer

pub struct CircularBuffer<A> { /* fields omitted */ }

A CircularBuffer that drops the oldest element inserted when full.

Example

let mut buf = CircularBuffer::<u32>::new(2);
assert_eq!(*buf.queue(), VecDeque::<u32>::from(vec![]));
assert!(buf.push(1).is_none());
assert_eq!(*buf.queue(), VecDeque::<u32>::from(vec![1]));
assert!(buf.push(2).is_none());
assert_eq!(*buf.queue(), VecDeque::<u32>::from(vec![1, 2]));
assert!(buf.push(3).is_some());
assert_eq!(*buf.queue(), VecDeque::<u32>::from(vec![2, 3]));
assert_eq!(buf.capacity(), 2);

Methods

impl<A> CircularBuffer<A>[src]

pub fn new(size: usize) -> Self[src]

Creates a new CircularBuffer with fixed size

pub fn push(&mut self, elem: A) -> Option<A>[src]

Add a value to the CircularBuffer Returns the popped value if the buffer is full

pub fn queue(&self) -> &VecDeque<A>[src]

Get an immutable reference to the values inside the CircularBuffer

pub fn capacity(&self) -> usize[src]

Returns the capacity of the circular buffer.

Trait Implementations

impl<A: Debug> Debug for CircularBuffer<A>[src]

Auto Trait Implementations

impl<A> Unpin for CircularBuffer<A> where
    A: Unpin, 

impl<A> Sync for CircularBuffer<A> where
    A: Sync, 

impl<A> Send for CircularBuffer<A> where
    A: Send, 

impl<A> UnwindSafe for CircularBuffer<A> where
    A: UnwindSafe, 

impl<A> RefUnwindSafe for CircularBuffer<A> where
    A: RefUnwindSafe, 

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

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

impl<T> Same<T> for T[src]

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>, [src]

impl<T> Resource for T where
    T: Any + Send + Sync, [src]

impl<T> Any for T where
    T: Any, [src]

impl<T> Event for T where
    T: Send + Sync + 'static, [src]

impl<T> Erased for T[src]

impl<T> Supports<T> for T[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
    D: AdaptFrom<S, Swp, Dwp, T>,
    Dwp: WhitePoint,
    Swp: WhitePoint,
    T: Component + Float, [src]

fn adapt_into(self) -> D[src]

Convert the source color to the destination color using the bradford method by default Read more

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where
    T: Parameter<Self>, [src]

Sets value as a parameter of self.