Struct SharedBoundedBufferPool 

pub struct SharedBoundedBufferPool(/* private fields */);

A threadsafe pool with a fixed number of Vec<u8> buffers.

Implementations

impl SharedBoundedBufferPool

pub fn new(pool_size: usize, max_buffer_capacity: usize) -> Self

Create a new SharedBoundedPool which has the indicated, fixed number of Vec<u8> buffers.

Whenever a buffer is returned to the pool, if its capacity is at most max_buffer_capacity, then Vec::clear is run on it; otherwise, it is replaced with a new empty Vec<u8>.

pub fn try_get(&self) -> Result<PooledBuffer<Self>, OutOfBuffers>

Get a buffer from the pool, if any are available.

pub fn get(&self) -> PooledBuffer<Self>

Get a buffer from the pool.

May need to wait for a buffer to become available.

Potential Panics or Deadlocks

If self.pool_size() == 0, then this method will panic or deadlock. This method may also cause a deadlock if no buffers are currently available, and the current thread needs to make progress in order to release a buffer.

pub fn pool_size(&self) -> usize

Get the total number of buffers in this pool, whether available or in-use.

pub fn available_buffers(&self) -> usize

Get the number of buffers in the pool which are not currently being used.

Trait Implementations

impl Clone for SharedBoundedBufferPool

fn clone(&self) -> SharedBoundedBufferPool

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SharedBoundedBufferPool

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

Formats the value using the given formatter.

impl<S: Speed> MirroredClone<S> for SharedBoundedBufferPool

Available on crate feature clone-behavior only.

fn mirrored_clone(&self) -> Self

Get a clone that shares all semantically-important mutable state with its source.

fn fast_mirrored_clone(&self) -> Self

where S: FastSpeed,

Get a clone that shares all semantically-important mutable state with its source.