Enum StreamRetentionConfig 

pub enum StreamRetentionConfig {
    Interest,
    Limits {
        max_age: Option<Duration>,
        max_messages: Option<i64>,
        max_bytes: Option<i64>,
    },
    WorkQueue {
        max_age: Option<Duration>,
        max_messages: Option<i64>,
        max_bytes: Option<i64>,
    },
}

Controls how long messages are retained in a JetStream stream.

The retention policy is immutable after stream creation — unlike most other stream settings, it cannot be changed via update_stream and requires deleting and recreating the stream.

Variants

Interest

Keep messages only while at least one consumer group is interested. Messages are removed once every subscribed consumer has acknowledged them. No event replay for consumers that join later.

Limits

Keep messages until explicit size/age/count limits are reached, then discard the oldest. None on any limit means unlimited. Enables event replay for consumers that join after the fact.

Fields

max_age: Option<Duration>

Drop messages older than this age (None = unlimited).

max_messages: Option<i64>

Drop oldest messages when count exceeds this (None = unlimited).

max_bytes: Option<i64>

Drop oldest messages when total bytes exceeds this (None = unlimited).

WorkQueue

Delete messages as soon as any consumer acknowledges them. Suitable for work-queue patterns where each message should be processed exactly once by any one worker.

Fields

max_age: Option<Duration>

Drop messages older than this age (None = unlimited).

max_messages: Option<i64>

Drop oldest messages when count exceeds this (None = unlimited).

max_bytes: Option<i64>

Drop oldest messages when total bytes exceeds this (None = unlimited).

Implementations

impl StreamRetentionConfig

pub(crate) fn build_stream_config( &self, name: String, subjects: Vec<String>, ) -> Config

Builds a [nats_stream::Config] for get_or_create_stream calls.

Trait Implementations

impl Clone for StreamRetentionConfig

fn clone(&self) -> StreamRetentionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamRetentionConfig

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

Formats the value using the given formatter.

impl Default for StreamRetentionConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for StreamRetentionConfig

impl PartialEq for StreamRetentionConfig

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