Struct CacheConfig 

pub struct CacheConfig {

    pub database: Option<DatabaseConfig>,
    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

database: Option<DatabaseConfig>

The configuration for the cache backing database.

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( database: Option<DatabaseConfig>, 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) -> Result<()>

Checks whether all cache settings are valid.

Errors

Returns an error 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 DerefToPyAny for CacheConfig

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<'a, 'py> FromPyObject<'a, 'py> for CacheConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for CacheConfig

type Target = CacheConfig

The Python output type

type Output = Bound<'py, <CacheConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

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 PyClass for CacheConfig

const NAME: &str = "CacheConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for CacheConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for `Cache` instances.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<CacheConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<CacheConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForCacheConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for CacheConfig

const TEXT_SIGNATURE: &'static str = "(encoding=None, timestamps_as_iso8601=None, buffer_interval_ms=None, bulk_read_batch_size=None, use_trader_prefix=None, use_instance_id=None, flush_on_start=None, drop_instruments_on_reset=None, tick_capacity=None, bar_capacity=None, save_market_data=None, persist_account_events=None)"

impl PyStubType for CacheConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for CacheConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

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