Struct MessageBusConfig 

pub struct MessageBusConfig {

    pub database: Option<DatabaseConfig>,
    pub encoding: SerializationEncoding,
    pub timestamps_as_iso8601: bool,
    pub buffer_interval_ms: Option<u32>,
    pub autotrim_mins: Option<u32>,
    pub use_trader_prefix: bool,
    pub use_trader_id: bool,
    pub use_instance_id: bool,
    pub streams_prefix: String,
    pub stream_per_topic: bool,
    pub external_streams: Option<Vec<String>>,
    pub types_filter: Option<Vec<String>>,
    pub heartbeat_interval_secs: Option<u16>,
}

Configuration for MessageBus instances.

Fields

database: Option<DatabaseConfig>

The configuration for the message bus 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. If false, then timestamps will be persisted as UNIX nanoseconds.

buffer_interval_ms: Option<u32>

The buffer interval (milliseconds) between pipelined/batched transactions. The recommended range if using buffered pipelining is [10, 1000] milliseconds, with a good compromise being 100 milliseconds.

autotrim_mins: Option<u32>

The lookback window in minutes for automatic stream trimming. The actual window may extend up to one minute beyond the specified value since streams are trimmed at most once every minute. This feature requires Redis version 6.2 or higher; otherwise, it will result in a command syntax error.

use_trader_prefix: bool

If a ‘trader-’ prefix is used for stream names.

use_trader_id: bool

If the trader’s ID is used for stream names.

use_instance_id: bool

If the trader’s instance ID is used for stream names. Default is false.

streams_prefix: String

The prefix for externally published stream names. Must have a database config.

stream_per_topic: bool

If true, messages will be written to separate streams per topic. If false, all messages will be written to the same stream.

external_streams: Option<Vec<String>>

The external stream keys the message bus will listen to for publishing deserialized message payloads internally.

types_filter: Option<Vec<String>>

A list of serializable types not to publish externally.

heartbeat_interval_secs: Option<u16>

The heartbeat interval (seconds).

Implementations

impl MessageBusConfig

pub fn builder() -> MessageBusConfigBuilder

Create an instance of MessageBusConfig using the builder syntax

Trait Implementations

impl Clone for MessageBusConfig

fn clone(&self) -> MessageBusConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageBusConfig

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

Formats the value using the given formatter.

impl Default for MessageBusConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MessageBusConfig

where MessageBusConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for MessageBusConfig

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 MessageBusConfig

type Target = MessageBusConfig

The Python output type

type Output = Bound<'py, <MessageBusConfig 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 MessageBusConfig

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

const NAME: &str = "MessageBusConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for MessageBusConfig

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 `MessageBus` 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 = <<MessageBusConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<MessageBusConfig>

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

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 MessageBusConfig

const TEXT_SIGNATURE: &'static str = "(database=None, encoding=None, timestamps_as_iso8601=None, buffer_interval_ms=None, autotrim_mins=None, use_trader_prefix=None, use_trader_id=None, use_instance_id=None, streams_prefix=None, stream_per_topic=None, external_streams=None, types_filter=None, heartbeat_interval_secs=None)"

impl PyStubType for MessageBusConfig

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 MessageBusConfig

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 MessageBusConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for MessageBusConfig

impl Eq for MessageBusConfig

impl StructuralPartialEq for MessageBusConfig