Struct StreamingConfig 

pub struct StreamingConfig {
    pub catalog_path: String,
    pub fs_protocol: String,
    pub flush_interval_ms: u64,
    pub replace_existing: bool,
    pub rotation_config: RotationConfig,
}

Configuration for streaming live or backtest runs to the catalog in feather format.

Fields

catalog_path: String

The path to the data catalog.

fs_protocol: String

The fsspec filesystem protocol for the catalog.

flush_interval_ms: u64

The flush interval (milliseconds) for writing chunks.

replace_existing: bool

If any existing feather files should be replaced.

rotation_config: RotationConfig

Rotation configuration.

Implementations

impl StreamingConfig

pub fn builder() -> StreamingConfigBuilder

Create an instance of StreamingConfig using the builder syntax

impl StreamingConfig

pub const fn new( catalog_path: String, fs_protocol: String, flush_interval_ms: u64, replace_existing: bool, rotation_config: RotationConfig, ) -> Self

Creates a new StreamingConfig instance.

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

Validates the streaming configuration, collecting every field violation.

Errors

Returns a [ConfigError] (a [ConfigError::Multiple] when more than one field is invalid) if any field fails validation.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamingConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.