Struct ringbuffer::AllocRingBuffer [−][src]
pub struct AllocRingBuffer<T> { /* fields omitted */ }
Expand description
The AllocRingBuffer
is a RingBufferExt
which is based on a Vec. This means it allocates at runtime
on the heap, and therefore needs the alloc
crate. This struct and therefore the dependency on
alloc can be disabled by disabling the alloc
(default) feature.
Example
use ringbuffer::{AllocRingBuffer, RingBuffer, RingBufferExt, RingBufferWrite};
let mut buffer = AllocRingBuffer::with_capacity(2);
// First entry of the buffer is now 5.
buffer.push(5);
// The last item we pushed is 5
assert_eq!(buffer.get(-1), Some(&5));
// Second entry is now 42.
buffer.push(42);
assert_eq!(buffer.peek(), Some(&5));
assert!(buffer.is_full());
// Because capacity is reached the next push will be the first item of the buffer.
buffer.push(1);
assert_eq!(buffer.to_vec(), vec![42, 1]);
Implementations
Creates a AllocRingBuffer
with a certain capacity. This capacity is fixed.
for this ringbuffer to work, cap must be a power of two and greater than zero.
Creates a AllocRingBuffer
with a certain capacity. The actual capacity is the input to the
function raised to the power of two (effectively the input is the log2 of the actual capacity)
Creates a AllocRingBuffer
with a certain capacity. The capacity must be a power of two.
Panics
Panics when capacity is zero or not a power of two
Creates an AllocRingBuffer
with a capacity of RINGBUFFER_DEFAULT_CAPACITY
.
Trait Implementations
Creates a buffer with a capacity of crate::RINGBUFFER_DEFAULT_CAPACITY
.
Extends a collection with the contents of an iterator. Read more
extend_one
)Extends a collection with exactly one element.
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
Creates a value from an iterator. Read more
Returns the length of the internal buffer. This length grows up to the capacity and then stops growing. This is because when the length is reached, new items are appended at the start. Read more
Gets a value relative to the current index. 0 is the next index to be written to with push. -1 and down are the last elements pushed and 0 and up are the items that were pushed the longest ago. Read more
Gets a value relative to the current index mutably. 0 is the next index to be written to with push. -1 and down are the last elements pushed and 0 and up are the items that were pushed the longest ago. Read more
Gets a value relative to the start of the array (rarely useful, usually you want Self::get
)
Gets a value mutably relative to the start of the array (rarely useful, usually you want Self::get_mut
)
Empties the buffer entirely. Sets the length to 0 but keeps the capacity allocated.
Sets every element in the ringbuffer to the value returned by f.
Sets every element in the ringbuffer to it’s default value
Returns the value at the current index.
This is the value that will be overwritten by the next push and also the value pushed
the longest ago. (alias of Self::front
) Read more
Returns the value at the front of the queue. This is the value that will be overwritten by the next push and also the value pushed the longest ago. (alias of peek) Read more
Returns a mutable reference to the value at the back of the queue. This is the value that will be overwritten by the next push. (alias of peek) Read more
Returns the value at the back of the queue. This is the item that was pushed most recently. Read more
Returns a mutable reference to the value at the back of the queue. This is the item that was pushed most recently. Read more
Creates a mutable iterator over the buffer starting from the item pushed the longest ago, and ending at the element most recently pushed. Read more
Creates an iterator over the buffer starting from the item pushed the longest ago, and ending at the element most recently pushed. Read more
Converts the buffer to a vector. This Copies all elements in the ringbuffer.
dequeues the top item off the ringbuffer, and moves this item out.
dequeues the top item off the queue, but does not return it. Instead it is dropped. If the ringbuffer is empty, this function is a nop. Read more
Auto Trait Implementations
impl<T> RefUnwindSafe for AllocRingBuffer<T> where
T: RefUnwindSafe,
impl<T> Send for AllocRingBuffer<T> where
T: Send,
impl<T> Sync for AllocRingBuffer<T> where
T: Sync,
impl<T> Unpin for AllocRingBuffer<T> where
T: Unpin,
impl<T> UnwindSafe for AllocRingBuffer<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more