Struct RetentionPolicy 

pub struct RetentionPolicy { /* private fields */ }

Ordered set of retention rules.

Rules are evaluated in insertion order. The first RetentionDecision::Keep or RetentionDecision::Drop wins; RetentionDecision::Defer falls through to later rules and finally to default_decision.

Example

use rig_memory_policy::{
    FrameKind, FrameMetadata, RetentionCandidate, RetentionDecision,
    RetentionPolicy,
};

let metadata = FrameMetadata {
    schema_version: 1,
    kind: FrameKind::CompactionSummary,
    conversation_id: "conv-1".into(),
    chat_role: "assistant".into(),
    dedup_key: "abc".into(),
    scope: Some("tenant-a".into()),
};
let policy = RetentionPolicy::new()
    .keep_summaries()
    .drop_written_before(1_700_000_000_000)
    .default_decision(RetentionDecision::Drop);

let decision = policy.evaluate(
    RetentionCandidate::new(&metadata).with_written_at_unix_ms(1_600_000_000_000),
);
assert_eq!(decision, RetentionDecision::Keep);

Implementations

impl RetentionPolicy

pub fn new() -> Self

Construct an empty policy with RetentionDecision::Defer as default.

pub fn rule(self, rule: RetentionRule) -> Self

Add a custom rule to the end of the policy.

pub fn default_decision(self, decision: RetentionDecision) -> Self

Set the decision returned when no rule matches.

pub fn keep_summaries(self) -> Self

Keep all compaction summaries.

pub fn keep_demoted_messages(self) -> Self

Keep all demoted messages.

pub fn keep_scope(self, scope: impl Into<Scope>) -> Self

Keep candidates in the required exact scope.

pub fn keep_recent(self, min_sequence: u64) -> Self

Keep candidates at or above min_sequence.

pub fn drop_written_before(self, older_than_unix_ms: u64) -> Self

Drop candidates written before older_than_unix_ms.

pub fn drop_last_accessed_before(self, older_than_unix_ms: u64) -> Self

Drop candidates last accessed before older_than_unix_ms.

pub fn drop_outside_scope( self, required_scope: Option<impl Into<Scope>>, ) -> Self

Drop candidates outside an exact scope. None keeps only unscoped candidates from matching this rule.

pub fn keep_label(self, label: impl Into<String>) -> Self

Keep candidates with the provided host-defined retention label.

pub fn drop_label(self, label: impl Into<String>) -> Self

Drop candidates with the provided host-defined retention label.

pub fn evaluate(&self, candidate: RetentionCandidate<'_>) -> RetentionDecision

Evaluate one candidate against this policy.

pub fn rules(&self) -> &[RetentionRule]

Return the ordered rules in this policy.

Trait Implementations

impl Clone for RetentionPolicy

fn clone(&self) -> RetentionPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetentionPolicy

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

Formats the value using the given formatter.

impl Default for RetentionPolicy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for RetentionPolicy

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

impl StructuralPartialEq for RetentionPolicy