Struct StreamingConfig 

pub struct StreamingConfig {

    pub writer_path: String,
    pub catalog: Option<DataCatalogConfig>,
    pub flush_interval_ms: u64,
    pub replace_existing: bool,
    pub rotation_config: RotationConfig,
    pub promotion_interval_ms: Option<u64>,
    pub promote_on_close: bool,
    pub delete_feather_after_promotion: bool,
    pub use_ts_event_for_ts_init: bool,
    pub data_types: Option<Vec<NautilusDataType>>,
    pub record_types: Option<Vec<NautilusRecordType>>,
    pub instrument_types: Option<Vec<NautilusInstrumentType>>,
    pub record_filters: Option<Vec<StreamingRecordFilterConfig>>,
    pub params: Option<Params>,
}

Configuration streaming live or backtest runs to a persistence writer.

The writer appends Feather files under the local writer_path, in one {backtest|sandbox|live}/{instance_id} directory per run. With a catalog, the writer for that catalog’s backend also promotes the files into it; without one, the Feather files are the only output.

Fields

writer_path: String

Local directory the writer appends Feather files to.

catalog: Option<DataCatalogConfig>

Catalog that receives promoted data; omit to keep only the Feather files.

flush_interval_ms: u64

Flush interval in milliseconds.

replace_existing: bool

Whether to replace existing files.

rotation_config: RotationConfig

Rotation configuration.

promotion_interval_ms: Option<u64>

Interval in milliseconds for promoting sealed files into catalog; omit for no interval.

promote_on_close: bool

Whether closing the writer promotes remaining files into catalog.

delete_feather_after_promotion: bool

Whether Feather files are deleted after a successful promotion.

use_ts_event_for_ts_init: bool

Whether promotion replaces ts_init with ts_event.

data_types: Option<Vec<NautilusDataType>>

Optional data families to write.

record_types: Option<Vec<NautilusRecordType>>

Optional record families to write.

instrument_types: Option<Vec<NautilusInstrumentType>>

Optional instrument families to write.

record_filters: Option<Vec<StreamingRecordFilterConfig>>

Optional record family and identifier filters.

params: Option<Params>

Backend-specific writer parameters.

Implementations

impl StreamingConfig

pub fn builder() -> StreamingConfigBuilder

Create an instance of StreamingConfig using the builder syntax

impl StreamingConfig

pub fn new( writer_path: String, catalog: Option<DataCatalogConfig>, flush_interval_ms: u64, replace_existing: bool, rotation_config: RotationConfig, ) -> StreamingConfig

Creates new StreamingConfig instance.

pub fn validate(&self) -> Result<(), ConfigError>

Validates the streaming configuration, collecting every field violation.

Errors

Returns an error if any field fails validation. Multiple validation failures are collected into one error.

pub fn writer_backend(&self) -> WriterBackendType

Returns the writer backend: Feather without a catalog, otherwise the catalog’s backend.

Trait Implementations

impl Clone for StreamingConfig

fn clone(&self) -> StreamingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingConfig

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

Formats the value using the given formatter.

impl DerefToPyAny for StreamingConfig

impl<'de> Deserialize<'de> for StreamingConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<StreamingConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

where StreamingConfig: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

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

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for StreamingConfig

type Target = StreamingConfig

The Python output type

type Output = Bound<'py, <StreamingConfig 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<<StreamingConfig as IntoPyObject<'py>>::Output, <StreamingConfig as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PyClass for StreamingConfig

const NAME: &'static str = "StreamingConfig"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyStubType for StreamingConfig

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 StreamingConfig

const NAME: &'static 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<&'static 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 StreamingConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.