Struct BatchStreamMemoryPool 

pub struct BatchStreamMemoryPool { /* private fields */ }

A pool of fixed-size byte buffers.

Buffers are zeroed when they are created; like the unmanaged blocks of the C# class they are not cleared when they are returned.

Implementations

impl BatchStreamMemoryPool

pub const DEFAULT_BUFFER_SIZE: usize = 1024

The buffer size used when none is specified.

pub fn new( reclaim_immediately: bool, buffer_size: usize, start_timer: Option<BatchStreamPoolStartTimer>, ) -> Self

pub fn buffer_size(&self) -> usize

Methods from Deref<Target = BatchStreamPoolBase<Box<[u8]>, BatchStreamMemoryPoolItems>>

pub fn current_usage(&self) -> i32

The number of items currently handed out.

pub fn current_pool(&self) -> i32

The number of items currently kept in the pool.

pub fn timer_is_running(&self) -> bool

Whether the owner is expected to call update_timer_tick once per second.

pub fn update_timer_tick(&self) -> bool

The timer procedure: trims the pool down to the number of items that were in use at the same time during the last 10 ticks (but keeps at least 10), and advances the usage statistics.

To be called by the owner once per second while the timer is running. Returns whether the timer keeps running.

pub fn get(&self) -> T

Takes an item from the pool, creating one when the pool is empty.

pub fn return_item(&self, item: T)

Gives an item back (C# Return). The item is cleared, and then kept for reuse unless the pool is disposed or reclaims immediately.

pub fn dispose(&self)

Destroys the pooled items; items returned from now on are destroyed instead of being kept.

Trait Implementations

impl Deref for BatchStreamMemoryPool

type Target = BatchStreamPoolBase<Box<[u8]>, BatchStreamMemoryPoolItems>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.