Enum RetentionClass 

pub enum RetentionClass {
    Hot,
    Warm,
    AuditArchive,
}

Named data-retention class from @store(class:).

A retention class is an operator-facing handle for a canonical eviction window: rather than computing evictAfter in raw seconds, a schema declares @store(class: "hot") and the loader resolves the class to the seconds value that populates StoreConfig::evict_after. From that point the existing TTL machinery does the rest — the per-record expiration header and the yeti.expiration_filter compaction filter reclaim aged records with no class-specific reclaim code.

The canonical durations are fixed by this enum so a class means the same window across every table and every deployment. A schema that needs a non-canonical window keeps using raw @store(evictAfter: N); the two are mutually exclusive (declaring both is a schema error).

Variants

Hot

"hot" — 30 days. Operational data with a short useful life: recent events, session-scoped state, ephemeral caches that still want crash durability.

Warm

"warm" — 90 days. Data kept for a quarter: rolling analytics windows, recent history surfaced in dashboards.

AuditArchive

"audit-archive" — 7 years (2557 days). Compliance-retained records: audit logs, financial records, anything under a multi-year statutory hold.

Implementations

impl RetentionClass

pub fn parse(s: &str) -> Option<Self>

Parse a @store(class:) string. Case-insensitive; the audit-archive class also accepts the audit_archive spelling so either separator works in a schema file.

pub const fn evict_after_secs(self) -> u64

The canonical eviction window for this class, in seconds. This is the value routed into StoreConfig::evict_after, so a class-tagged table flows through the identical TTL + compaction path as a raw evictAfter.

pub const fn as_str(self) -> &'static str

The canonical name as it appears in a schema directive.

Trait Implementations

impl Clone for RetentionClass

fn clone(&self) -> RetentionClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RetentionClass

impl Debug for RetentionClass

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RetentionClass

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RetentionClass

impl Hash for RetentionClass

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RetentionClass

fn cmp(&self, other: &RetentionClass) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RetentionClass

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

fn partial_cmp(&self, other: &RetentionClass) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RetentionClass

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RetentionClass