Struct RedisCacheDatabase 

pub struct RedisCacheDatabase {
    pub con: ConnectionManager,
    pub trader_id: TraderId,
    pub trader_key: String,
    pub encoding: SerializationEncoding,
    pub bulk_read_batch_size: Option<usize>,
    /* private fields */
}

Fields

con: ConnectionManager

trader_id: TraderId

trader_key: String

encoding: SerializationEncoding

bulk_read_batch_size: Option<usize>

Implementations

impl RedisCacheDatabase

pub async fn new( trader_id: TraderId, instance_id: UUID4, config: CacheConfig, ) -> Result<Self>

Creates a new RedisCacheDatabase instance for the given trader_id, instance_id, and config.

Errors

Returns an error if:

• The database configuration is missing in config.
• Establishing the Redis connection fails.
• The command processing task cannot be spawned.

pub const fn get_encoding(&self) -> SerializationEncoding

pub fn get_trader_key(&self) -> &str

pub fn close(&mut self)

pub async fn flushdb(&mut self)

pub fn flushdb_sync(&self) -> Result<()>

Sends a flush command through the background task channel and blocks until it completes. Safe to call from any runtime context.

Errors

Returns an error if the command channel is closed or the reply is lost.

pub async fn keys(&mut self, pattern: &str) -> Result<Vec<String>>

Retrieves all keys matching the given pattern from Redis for this trader.

Errors

Returns an error if the underlying Redis scan operation fails.

pub async fn read(&mut self, key: &str) -> Result<Vec<Bytes>>

Reads the value(s) associated with key for this trader from Redis.

Errors

Returns an error if the underlying Redis read operation fails.

pub async fn read_bulk(&mut self, keys: &[String]) -> Result<Vec<Option<Bytes>>>

Reads multiple values using bulk operations for efficiency.

Errors

Returns an error if the underlying Redis read operation fails.

pub fn load_custom_data(&self, data_type: &DataType) -> Result<Vec<CustomData>>

Loads custom data from Redis matching the given data_type (blocking).

Spawns the async query on the global Nautilus runtime and blocks until the result arrives via a channel. Safe from any thread context (Python, test runtimes, plain threads).

Errors

Returns an error if the query fails or the reply channel is closed.

pub fn insert(&self, key: String, payload: Option<Vec<Bytes>>) -> Result<()>

Sends an insert command for key with optional payload to Redis via the background task.

Errors

Returns an error if the command cannot be sent to the background task channel.

pub fn add_custom_data(&self, data: &CustomData) -> Result<()>

Stores custom data in Redis (key format: custom:<ts_init_020>:<uuid>, value: full JSON).

Errors

Returns an error if serialization fails or the insert command cannot be sent.

pub fn update(&mut self, key: String, payload: Option<Vec<Bytes>>) -> Result<()>

Sends an update command for key with optional payload to Redis via the background task.

Errors

Returns an error if the command cannot be sent to the background task channel.

pub fn delete(&mut self, key: String, payload: Option<Vec<Bytes>>) -> Result<()>

Sends a delete command for key with optional payload to Redis via the background task.

Errors

Returns an error if the command cannot be sent to the background task channel.

pub fn delete_order(&self, client_order_id: &ClientOrderId) -> Result<()>

Delete the given order from the database with full index cleanup.

Errors

Returns an error if the command cannot be sent to the background task channel.

pub fn delete_position(&self, position_id: &PositionId) -> Result<()>

Delete the given position from the database with full index cleanup.

Errors

Returns an error if the command cannot be sent to the background task channel.

pub fn delete_account_event( &self, _account_id: &AccountId, _event_id: &str, ) -> Result<()>

Delete the given account event from the database.

Errors

Returns an error if the command cannot be sent to the background task channel.

Trait Implementations

impl Debug for RedisCacheDatabase

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for RedisCacheDatabase

type Target = RedisCacheDatabase

The Python output type

type Output = Bound<'py, <RedisCacheDatabase 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 PyClass for RedisCacheDatabase

const NAME: &str = "RedisCacheDatabase"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RedisCacheDatabase

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 = c"\x00"

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 = <<RedisCacheDatabase as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<RedisCacheDatabase>

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 = Pyo3MethodsInventoryForRedisCacheDatabase

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 RedisCacheDatabase

const TEXT_SIGNATURE: &'static str = "(trader_id, instance_id, config_json)"

impl PyTypeInfo for RedisCacheDatabase

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 DerefToPyAny for RedisCacheDatabase

impl ExtractPyClassWithClone for RedisCacheDatabase