Struct CacheConfig 

pub struct CacheConfig {
    pub encoding: SerializationEncoding,
    pub timestamps_as_iso8601: bool,
    pub buffer_interval_ms: Option<usize>,
    pub bulk_read_batch_size: Option<usize>,
    pub use_trader_prefix: bool,
    pub use_instance_id: bool,
    pub flush_on_start: bool,
    pub drop_instruments_on_reset: bool,
    pub tick_capacity: usize,
    pub bar_capacity: usize,
    pub persist_account_events: bool,
    pub save_market_data: bool,
}

Configuration for Cache instances.

Fields

encoding: SerializationEncoding

The encoding for database operations, controls the type of serializer used.

timestamps_as_iso8601: bool

If timestamps should be persisted as ISO 8601 strings.

buffer_interval_ms: Option<usize>

The buffer interval (milliseconds) between pipelined/batched transactions.

bulk_read_batch_size: Option<usize>

The batch size for bulk read operations (e.g., MGET). If set, bulk reads will be batched into chunks of this size.

use_trader_prefix: bool

If a ‘trader-’ prefix is used for keys.

use_instance_id: bool

If the trader’s instance ID is used for keys.

flush_on_start: bool

If the database should be flushed on start.

drop_instruments_on_reset: bool

If instrument data should be dropped from the cache’s memory on reset.

tick_capacity: usize

The maximum length for internal tick deques.

bar_capacity: usize

The maximum length for internal bar deques.

persist_account_events: bool

If account events should be persisted to a backing database.

save_market_data: bool

If market data should be persisted to disk.

Implementations

impl CacheConfig

pub fn builder() -> CacheConfigBuilder

Create an instance of CacheConfig using the builder syntax

impl CacheConfig

pub fn new( encoding: SerializationEncoding, timestamps_as_iso8601: bool, buffer_interval_ms: Option<usize>, bulk_read_batch_size: Option<usize>, use_trader_prefix: bool, use_instance_id: bool, flush_on_start: bool, drop_instruments_on_reset: bool, tick_capacity: usize, bar_capacity: usize, persist_account_events: bool, save_market_data: bool, ) -> Self

Creates a new CacheConfig instance.

Panics

Panics if tick_capacity or bar_capacity is zero.

pub fn validate(&self) -> ConfigResult<()>

Checks whether all cache settings are valid.

Errors

Returns a ConfigError if a capacity setting is not positive.

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CacheConfig

where CacheConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for CacheConfig

impl PartialEq for CacheConfig

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CacheConfig