Struct SegmentConfig 

#[non_exhaustive]
pub struct SegmentConfig {
    pub flush_policy: FlushPolicy,
    pub max_size_bytes: u64,
    pub compression_level: i32,
    pub cipher: Option<Box<dyn SegmentCipher>>,
}

Configuration knobs for SegmentBuffer.

This struct is #[non_exhaustive]: new fields may be added in any release without breaking semver. Construct via SegmentConfig::builder() and then mutate the public fields you care about, or use SegmentConfig::default() directly:

use segment_buffer::SegmentConfig;

let mut config = SegmentConfig::default();
config.max_size_bytes = 1024 * 1024;

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flush_policy: FlushPolicy

When to auto-flush pending items. See FlushPolicy for the options.

max_size_bytes: u64

Max total disk usage before the buffer reports overload pressure (default: 10 GB).

compression_level: i32

zstd compression level (1-22; 3 is fast with a good ratio).

cipher: Option<Box<dyn SegmentCipher>>

Optional cipher for encrypting segment files at rest. When None, segments are written as plaintext zstd+CBOR.

Implementations

impl SegmentConfig

pub fn builder() -> SegmentConfigBuilder

Begin a builder. Every field starts at SegmentConfig::default; chain setter calls to override the ones you care about.

Trait Implementations

impl Debug for SegmentConfig

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

Formats the value using the given formatter.

impl Default for SegmentConfig

fn default() -> Self

Returns the “default value” for a type.