Struct CachekitConfigBuilder 

pub struct CachekitConfigBuilder { /* private fields */ }

Fluent builder for CachekitConfig.

Implementations

impl CachekitConfigBuilder

pub fn new() -> Self

Create a new builder with defaults.

pub fn api_key(self, key: impl Into<String>) -> Self

Set the API key.

pub fn api_url(self, url: impl Into<String>) -> Result<Self, CachekitError>

Set the API base URL. Must use HTTPS.

pub fn master_key(self, hex_key: &str) -> Result<Self, CachekitError>

Set the master key from a hex string. Must decode to at least 32 bytes.

pub fn previous_master_keys( self, hex_keys: &[&str], ) -> Result<Self, CachekitError>

Set decrypt-only previous master keys from hex strings, in attempt order. Retained during a key-rotation grace window: reads attempt the current master key first, then each of these sequentially.

Validation is identical to Self::master_key per entry (valid hex, at least 32 bytes). At most MAX_PREVIOUS_MASTER_KEYS entries — more is a CachekitError::Config, never truncated. The current master key must not reappear here (forward-only rotation: a retired key is never re-promoted).

Examples

use cachekit::config::CachekitConfigBuilder;

// k2 is current after rotation; k1 stays readable during the grace window.
let k1 = "11".repeat(32);
let k2 = "22".repeat(32);

let config = CachekitConfigBuilder::new()
    .master_key(&k2)?
    .previous_master_keys(&[k1.as_str()])?
    .build();

assert_eq!(config.previous_master_keys.len(), 1);

pub fn default_ttl(self, ttl: Duration) -> Result<Self, CachekitError>

Set the default TTL. Must be at least 1 second.

pub fn namespace(self, ns: impl Into<String>) -> Self

Set the namespace prefix.

pub fn l1_capacity(self, capacity: usize) -> Self

Set the L1 cache capacity (max entries).

pub fn build(self) -> CachekitConfig

Finalise and return the CachekitConfig.

Trait Implementations

impl Default for CachekitConfigBuilder

fn default() -> Self

Returns the “default value” for a type.