Struct PipelineConfig 

pub struct PipelineConfig {
    pub pipeline: PipelineSection,
    pub checkpoint: CheckpointSection,
    pub backpressure: BackpressureSection,
    pub metrics: MetricsSection,
    pub source: ComponentConfig,
    pub deserializer: Option<ComponentConfig>,
    pub sink: Option<ComponentConfig>,
    pub sinks: Option<BTreeMap<String, ComponentConfig>>,
}

Root of a pipeline’s configuration file.

One process runs one pipeline; one file configures one process.

Fields

pipeline: PipelineSection

Identity and thread budget.

checkpoint: CheckpointSection

Watermark commit policy.

backpressure: BackpressureSection

In-flight budget and pause/resume hysteresis.

metrics: MetricsSection

Exporter selection and observability knobs.

source: ComponentConfig

The source component (opaque body).

deserializer: Option<ComponentConfig>

Optional deserializer component (opaque body). Sources that emit ready-made records need none.

sink: Option<ComponentConfig>

Single sink component (opaque body) — sugar for the common one-sink case, addressed as "default". Mutually exclusive with sinks. Resolve via sink_config.

sinks: Option<BTreeMap<String, ComponentConfig>>

Named sinks for a multi-sink split: a name -> component map, each an ordinary single-key component (clickhouse: {...}). Mutually exclusive with sink. Resolve via sink_config.

Implementations

impl PipelineConfig

pub fn from_str(text: &str) -> Result<Self, ConfigError>

Load from YAML text: interpolate ${VAR} forms against the process environment, parse, and validate.

pub fn from_path(path: &Path) -> Result<Self, ConfigError>

Load from a YAML file (read, interpolate, parse, validate).

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

Cross-field validation, run automatically by the loaders. Public so programmatically built configs (tests, spate-test) get the same checks.

pub fn sink_config(&self, name: &str) -> Result<&ComponentConfig, ConfigError>

The component config for the sink named name. The single-sink sink: form is addressed as "default". A connector factory calls this once per sink to build it.

Errors

ConfigError::Validation if no sink is configured under name.

pub fn sink_names(&self) -> Vec<String>

The configured sink names, sorted. A single-sink config reports ["default"].

Trait Implementations

impl Debug for PipelineConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PipelineConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PipelineConfig

fn eq(&self, other: &PipelineConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PipelineConfig