Struct mini_io_queue::storage::HeapBuffer

pub struct HeapBuffer<T>(_);

Available on crate feature heap-buffer only.

Backing buffer for a queue, allocated on the heap.

All queues require a backing buffer which implements the Storage trait. This buffer stores values in a contiguous array allocated on the heap. Compare this to StackBuffer which uses a contiguous array on the stack. Note that the asyncio, blocking and nonblocking queues move their buffer to the heap anyway.

Example

use mini_io_queue::nonblocking;
use mini_io_queue::storage::HeapBuffer;

let buffer: HeapBuffer<u8> = HeapBuffer::new(100);
let (reader, writer) = nonblocking::queue_from(buffer);

Implementations

impl<T> HeapBuffer<T> where
    T: Default, 

pub fn new(capacity: usize) -> Self

Creates a buffer with the provided capacity. All elements in the buffer will be initialized to the item’s default value.

Trait Implementations

impl<T> AsRef<[UnsafeCell<T>]> for HeapBuffer<T>

fn as_ref(&self) -> &[UnsafeCell<T>]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> From<Box<[T], Global>> for HeapBuffer<T>

fn from(boxed_slice: Box<[T]>) -> Self

Converts to this type from the input type.

impl<T> Send for HeapBuffer<T> where
    T: Send, 

impl<T> Sync for HeapBuffer<T> where
    T: Sync,