Struct RunStreamOptions 

pub struct RunStreamOptions {

    pub state_store: Option<Arc<dyn StateStore>>,
    pub state_key: Option<String>,
    pub pipeline_name: Option<String>,
    pub row: Option<String>,
    pub run_id: Option<String>,
    pub dlq: Option<DlqConfig>,
    pub quality: Option<Arc<CompiledQuality>>,
    pub contract: Option<Arc<CompiledContract>>,
    pub masking: Option<Arc<CompiledMasking>>,
    pub adaptive: Option<AdaptiveBatchConfig>,
    pub cancel: Option<CancellationToken>,
    pub delivery: DeliveryMode,
    pub start_seq: u64,
    pub replay: Option<ReplayGuarantee>,
    pub resilience: Option<ResiliencePolicy>,
    pub schema_drift: Option<SchemaDriftPolicy>,
}

Fields

state_store: Option<Arc<dyn StateStore>>

state_key: Option<String>

pipeline_name: Option<String>

row: Option<String>

run_id: Option<String>

dlq: Option<DlqConfig>

quality: Option<Arc<CompiledQuality>>

Available on crate feature quality only.

contract: Option<Arc<CompiledContract>>

Available on crate feature contract only.

Compiled data contract (issue #204). The pass runs per page after the quality pass and before the schema-drift pass.

masking: Option<Arc<CompiledMasking>>

Available on crate feature masking only.

Compiled masking policy (issue #206). The pass runs per page first — before quality/contract/drift and every sink write — so PII never reaches a sink, the DLQ, or a lineage sample unmasked.

adaptive: Option<AdaptiveBatchConfig>

Adaptive batch-size controller config; None (or enabled = false) leaves the per-page write path unchanged.

cancel: Option<CancellationToken>

Cooperative cancellation. When set and cancelled mid-run, the streaming loop stops polling new pages, flushes the sinks (so a buffered sink like Parquet writes its footer / completes its upload rather than orphaning the file), and returns the partial result. Without this, a dropped run future loses everything written-but-unflushed (#146 H16).

delivery: DeliveryMode

Delivery guarantee. AtLeastOnce (default) leaves the write path unchanged. ExactlyOnce enables the resume/skip + atomic-token path.

start_seq: u64

Resume sequence read from the (unwrapped) exactly-once state value. Ignored unless delivery == ExactlyOnce. Defaults to 0.

replay: Option<ReplayGuarantee>

The source’s replay capability, when the caller knows it. Some(NonDeterministic) steers an ExactlyOnce run away from the atomic-watermark skip path (whose correctness depends on positional replay) and onto the keyed-upsert mechanism when the sink is configured for it. None (default) trusts the caller — today’s behaviour for library users driving run_stream directly. Pipeline::run always sets it from Source::replay_guarantee().

resilience: Option<ResiliencePolicy>

Optional resilience policy (retry/backoff/circuit-breaker/poison).

schema_drift: Option<SchemaDriftPolicy>

Compiled schema-drift policy (issue #194). None → no drift handling.

Implementations

impl RunStreamOptions

pub fn new() -> RunStreamOptions

pub fn with_state( self, store: Arc<dyn StateStore>, key: impl Into<String>, ) -> RunStreamOptions

pub fn with_name(self, name: impl Into<String>) -> RunStreamOptions

pub fn with_row(self, row: impl Into<String>) -> RunStreamOptions

pub fn with_run_id(self, id: impl Into<String>) -> RunStreamOptions

pub fn with_dlq(self, dlq: DlqConfig) -> RunStreamOptions

pub fn with_cancel(self, cancel: CancellationToken) -> RunStreamOptions

Attach a cancellation token for cooperative, flush-completing cancel.

pub fn with_adaptive(self, cfg: AdaptiveBatchConfig) -> RunStreamOptions

Attach an adaptive batch-size controller config.

pub fn with_quality(self, quality: Arc<CompiledQuality>) -> RunStreamOptions

Available on crate feature quality only.

pub fn with_contract(self, contract: Arc<CompiledContract>) -> RunStreamOptions

Available on crate feature contract only.

Attach a compiled data contract. The pass runs per page after the quality pass and before the schema-drift pass.

pub fn with_masking(self, masking: Arc<CompiledMasking>) -> RunStreamOptions

Available on crate feature masking only.

Attach a compiled masking policy. The pass runs per page first — before quality/contract/drift and every sink write.

pub fn with_delivery(self, mode: DeliveryMode) -> RunStreamOptions

Set the delivery mode.

pub fn with_replay_guarantee(self, replay: ReplayGuarantee) -> RunStreamOptions

Set the resume sequence (exactly-once). Normally derived by Pipeline::run from the unwrapped state value. Declare the source’s replay capability (see the replay field).

pub fn with_start_seq(self, seq: u64) -> RunStreamOptions

pub fn with_resilience(self, policy: ResiliencePolicy) -> RunStreamOptions

Attach a resilience policy to the run.

pub fn with_schema_drift(self, policy: SchemaDriftPolicy) -> RunStreamOptions

Attach a compiled schema-drift policy. The pass runs per page after the quality pass and before the sink write.

Trait Implementations

impl Clone for RunStreamOptions

fn clone(&self) -> RunStreamOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RunStreamOptions

fn default() -> RunStreamOptions

Returns the “default value” for a type.