Struct SubmitOptions 

pub struct SubmitOptions {
    pub redis: bool,
    pub redis_ttl: Option<CacheTtl>,
    pub sql: bool,
    pub state: Option<String>,
}

Options for controlling where data is stored.

sync-engine is a dumb byte router - it stores Vec<u8> and routes to L1 (always), L2 (Redis), and L3 (SQL) based on these options.

Compression is the caller’s responsibility. Compress before submit if desired. This allows callers to choose their trade-offs:

• Compressed data = smaller storage, but no SQL JSON search
• Uncompressed JSON = SQL JSON functions work, larger storage

Fields

redis: bool

Store in L2 Redis.

Default: true

redis_ttl: Option<CacheTtl>

TTL for Redis key. None means no expiry.

Use CacheTtl enum values for efficient batching.

Default: None

sql: bool

Store in L3 SQL (MySQL/SQLite).

Default: true

state: Option<String>

Override state tag for this item.

If Some, overrides the item’s existing state. If None, uses the item’s current state (default: “default”).

State is indexed for fast queries: SQL index + Redis SETs.

Implementations

impl SubmitOptions

pub fn cache(ttl: CacheTtl) -> Self

Create options for Redis-only ephemeral cache with TTL.

Uses CacheTtl enum for efficient batching. Items with the same TTL variant are batched together in a single Redis pipeline.

• Redis: yes, not compressed (searchable)
• SQL: no

Example

use sync_engine::{SubmitOptions, CacheTtl};

// Standard 1-hour cache (batches efficiently)
let opts = SubmitOptions::cache(CacheTtl::Hour);

// 5-minute short cache
let opts = SubmitOptions::cache(CacheTtl::Short);

pub fn durable() -> Self

Create options for SQL-only durable storage.

• Redis: no
• SQL: yes

pub fn with_state(self, state: impl Into<String>) -> Self

Set the state for items submitted with these options (builder pattern).

Example

use sync_engine::SubmitOptions;

let opts = SubmitOptions::default().with_state("delta");

pub fn stores_anywhere(&self) -> bool

Returns true if data should be stored anywhere.

Trait Implementations

impl Clone for SubmitOptions

fn clone(&self) -> SubmitOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubmitOptions

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

Formats the value using the given formatter.

impl Default for SubmitOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<&SubmitOptions> for OptionsKey

fn from(opts: &SubmitOptions) -> Self

Converts to this type from the input type.

impl From<SubmitOptions> for OptionsKey

fn from(opts: SubmitOptions) -> Self

Converts to this type from the input type.