Struct mz_secrets::cache::CachingSecretsReader

pub struct CachingSecretsReader {
    inner: Arc<dyn SecretsReader>,
    cache: Arc<RwLock<BTreeMap<CatalogItemId, CacheItem>>>,
    policy: Arc<CachingParameters>,
}

Fields

inner: Arc<dyn SecretsReader>

The underlying secrets, source of truth.

cache: Arc<RwLock<BTreeMap<CatalogItemId, CacheItem>>>

In-memory cache, not having a size limit or eviction policy is okay because we limit users to 100 secrets, which should not be a problem to store in-memory.

policy: Arc<CachingParameters>

Caching policy, can change at runtime, e.g. via LaunchDarkly.

Implementations

impl CachingSecretsReader

pub fn new(reader: Arc<dyn SecretsReader>) -> Self

pub fn set_policy(&self, policy: CachingPolicy)

fn enable_caching(&self) -> bool

Enables caching, returning whether we were previously enabled.

fn disable_caching(&self) -> bool

Disables caching, returning whether we were previously enabled.

fn set_ttl(&self, ttl: Duration) -> Duration

Sets a new “time to live” for cache values, returning the old TTL.

Trait Implementations

impl Clone for CachingSecretsReader

fn clone(&self) -> CachingSecretsReader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CachingSecretsReader

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

Formats the value using the given formatter.

impl SecretsReader for CachingSecretsReader

fn read<'life0, 'async_trait>( &'life0 self, id: CatalogItemId, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the binary contents of the specified secret.

fn read_string<'life0, 'async_trait>( &'life0 self, id: CatalogItemId, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the string contents of the specified secret.