Struct BatchStreamPoolBase 

pub struct BatchStreamPoolBase<T, I: IBatchStreamPoolItems<T>> { /* private fields */ }

A pool that keeps a number of elements that was used in the last 10 seconds

Trimming

The C# class trims itself from a one second timer that it starts on the dispatcher of the thread it was created on (or through a startTimer delegate that receives the timer procedure). This port has no timer of its own; the owner drives it instead:

• while timer_is_running is true, the owner calls update_timer_tick once per second;
• when update_timer_tick returns false the timer has stopped (the pool saw no activity for 21 ticks) and the owner stops calling it;
• the timer starts again on the next get or return_item. The optional start_timer callback given to the constructor is invoked each time that happens (and once from the constructor), so the owner does not have to poll timer_is_running. The callback is invoked on the thread that used the pool, outside of the pool lock.

A pool created with reclaim_immediately never keeps returned items and never asks for a timer.

Implementations

impl<T, I: IBatchStreamPoolItems<T>> BatchStreamPoolBase<T, I>

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

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<T, I: IBatchStreamPoolItems<T>> Drop for BatchStreamPoolBase<T, I>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.