Enum BufferCfg 

pub enum BufferCfg {
    SpmcRing {
        capacity: usize,
    },
    SingleLatest,
    Mailbox,
}

Buffer configuration for a record type

Selects buffering strategy: SPMC Ring (backlog), SingleLatest (state sync), or Mailbox (commands).

Quick Selection Guide

• High-frequency data (>10 Hz): SpmcRing with tuned capacity
• State/config updates: SingleLatest (only latest matters)
• Commands/one-shot events: Mailbox

Examples

use aimdb_core::buffer::BufferCfg;

let telemetry = BufferCfg::SpmcRing { capacity: 2048 };  // High-freq data
let config = BufferCfg::SingleLatest;                     // State sync
let commands = BufferCfg::Mailbox;                        // Commands

Variants

SpmcRing

SPMC (Single Producer, Multiple Consumer) ring buffer

Best for high-frequency data streams with bounded memory. Fast producers can outrun slow consumers (lag detection). Oldest messages dropped on overflow.

Sizing: capacity = data_rate_hz × lag_seconds (use power-of-2)

Fields

capacity: usize

Maximum number of items in the buffer

SingleLatest

Single latest value buffer (no backlog)

Only most recent value is kept. Consumers always get latest state. Intermediate updates are collapsed. Use when history doesn’t matter.

Mailbox

Single-slot mailbox with overwrite

New value overwrites old if not consumed. At-least-once delivery. Use for commands where latest command wins.

Implementations

impl BufferCfg

pub fn validate(&self) -> Result<(), &'static str>

Validates the buffer configuration

Returns Err if SPMC Ring capacity is 0.

pub fn name(&self) -> &'static str

Returns a human-readable name for this buffer type

pub fn estimated_memory_bytes( &self, item_size: usize, consumer_count: usize, ) -> usize

Returns estimated memory overhead for this buffer type

Approximation; varies by implementation and platform.

Trait Implementations

impl Clone for BufferCfg

fn clone(&self) -> BufferCfg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferCfg

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

Formats the value using the given formatter.

impl Default for BufferCfg

fn default() -> Self

Returns the default buffer configuration: SpmcRing { capacity: 1024 }

impl<'de> Deserialize<'de> for BufferCfg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BufferCfg

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

Formats the value using the given formatter.

impl PartialEq for BufferCfg

fn eq(&self, other: &BufferCfg) -> 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 Serialize for BufferCfg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BufferCfg

impl StructuralPartialEq for BufferCfg