Enum CacheTtl 

pub enum CacheTtl {
    Minute,
    Short,
    Medium,
    Hour,
    Day,
    Week,
    Custom(u64),
}

Standard cache TTL values that encourage batch grouping.

Using standard TTLs means items naturally batch together for efficient pipelined writes. Custom durations are supported but should be used sparingly.

Batching Behavior

Items with the same CacheTtl variant are batched together:

• 1000 items with CacheTtl::Short → 1 Redis pipeline
• 500 items with CacheTtl::Short + 500 with CacheTtl::Hour → 2 pipelines

Example

use sync_engine::{SubmitOptions, CacheTtl};

// Prefer standard TTLs for batching efficiency
let opts = SubmitOptions::cache(CacheTtl::Hour);

// Custom TTL when you really need a specific duration
let opts = SubmitOptions::cache(CacheTtl::custom_secs(90));

Variants

Minute

1 minute - very short-lived cache

Short

5 minutes - short cache

Medium

15 minutes - medium cache

Hour

1 hour - standard cache (most common)

Day

24 hours - long cache

Week

7 days - very long cache

Custom(u64)

Custom duration in seconds (use sparingly to preserve batching)

Implementations

impl CacheTtl

pub fn custom_secs(secs: u64) -> Self

Create a custom TTL from seconds.

Prefer standard TTLs (Minute, Hour, etc.) for better batching. Custom TTLs create separate batches, reducing pipeline efficiency.

pub fn to_duration(self) -> Duration

Convert to Duration.

pub fn as_secs(self) -> u64

Get the TTL in seconds (for OptionsKey grouping).

Trait Implementations

impl Clone for CacheTtl

fn clone(&self) -> CacheTtl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheTtl

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

Formats the value using the given formatter.

impl From<Duration> for CacheTtl

fn from(d: Duration) -> Self

Convert Duration to CacheTtl, snapping to standard values when close.

impl Hash for CacheTtl

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 PartialEq for CacheTtl

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

impl Eq for CacheTtl

impl StructuralPartialEq for CacheTtl