Struct CacheBuilder 

pub struct CacheBuilder<DC>
where
    DC: DataController,
    DC::Key: Send + Sync + 'static,
    DC::Error: Send + Sync + 'static,
{ /* private fields */ }

Builder object of Cache.

See Cache::builder() method.

Implementations

impl<DC> CacheBuilder<DC>

where DC: DataController, DC::Key: Send + Sync + 'static, DC::Error: Send + Sync + 'static,

pub fn data_controller<FXVALINTO: Into<Arc<DC>>>(self, value: FXVALINTO) -> Self

The data controller object.

pub fn name(self, value: &'static str) -> Self

Cache name.

pub fn max_updates(self, value: u64) -> Self

The maximum size of the updates pool. This not a hard limit but a threshold that triggers automatic flushing by the background task.

Defaults to 100.

pub fn max_capacity(self, value: u64) -> Self

The maximum cache capacity. This is a hard limit on the number of key entries (not records). See the crate documentation for details.

Defaults to 10000.

pub fn flush_interval(self, value: Duration) -> Self

The delay between two consecutive flushes. If a flush was manually requested then the timer is reset.

pub fn monitor_tick_duration(self, value: u64) -> Self

The period of time between two consecutive checks of the cache state by the background task.

pub fn new() -> Self

pub fn build(&mut self) -> Result<Arc<Cache<DC>>, FieldXError>

Builds the struct from the builder object.

impl<DC> CacheBuilder<DC>

where DC: DataController,

pub fn observer(self, observer: impl Observer<DC>) -> Self

Adds an observer to the cache.

Trait Implementations

impl<DC> Default for CacheBuilder<DC>

where DC: DataController + Default, DC::Key: Send + Sync + 'static, DC::Error: Send + Sync + 'static + Default,

fn default() -> CacheBuilder<DC>

Returns the “default value” for a type.