Struct BufPoolCfg 

pub struct BufPoolCfg {
    pub buffer_size: BufferSize,
    pub max_memory: usize,
}

All the available configrations for BufPool

Example

use frozen_core::{bufpool::BufPoolCfg, utils::BufferSize};

const BUF_SIZE: BufferSize = BufferSize::S64;

let cfg = BufPoolCfg {
    buffer_size: BUF_SIZE,
    max_memory: BUF_SIZE as usize * 0x1000,
};

assert_ne!(cfg.max_memory, 0);
assert!(cfg.max_memory > cfg.buffer_size.bytes());

Fields

buffer_size: BufferSize

Size (in bytes) of an indivdual buffer unit allocated

max_memory: usize

Maximum allowed memory (in bytes) to be simultaneosuly allocated by BufPool

IMPORTANT: When trying to allocate more memory then BufPoolCfg::max_memory via BufPool::allocate, a deadlock will happen due to memory budgeting in place. The caller must make sure the max_meory is high enough to avoid this scenerio.

NOTE: To avoid backpressure, set the max_memory to an arbitrary large value. This would not have any direct impact on performance or resource usage, and will avoid backpressure under heavy workload.

Trait Implementations

impl Clone for BufPoolCfg

fn clone(&self) -> BufPoolCfg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BufPoolCfg

impl Debug for BufPoolCfg

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

Formats the value using the given formatter.

impl Eq for BufPoolCfg

impl PartialEq for BufPoolCfg

fn eq(&self, other: &BufPoolCfg) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BufPoolCfg