Struct CsvSinkConfig 

pub struct CsvSinkConfig {
    pub path: String,
    pub delimiter: u8,
    pub write_headers: bool,
    pub append: bool,
    pub batch_size: usize,
    pub compression: CompressionConfig,
}

Available on crate feature sink-csv only.

Configuration for the CSV file sink.

Fields

path: String

Path to the output CSV file.

delimiter: u8

Field delimiter byte. Defaults to b','.

write_headers: bool

Whether to write a header row. Defaults to true.

append: bool

Whether to append to an existing file. Defaults to false (truncates).

batch_size: usize

Records per upstream StreamPage. The CSV sink writes rows to disk one at a time inside a spawn_blocking task fronted by a buffered csv::Writer, so this field has no behavioural impact at the sink — it is exposed purely for config parity across every sink in the workspace. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 (the “no batching” sentinel) and any positive value produce byte-for-byte identical output for this sink: each record is serialised and written individually regardless of how upstream chunked the page.

compression: CompressionConfig

Available on crate feature compression only.

Compression codec for the output file. Defaults to CompressionConfig::Auto — .gz / .zst suffix selects gzip / zstd. Requires the crate-local compression feature.

Implementations

impl CsvSinkConfig

pub fn new(path: impl Into<String>) -> CsvSinkConfig

Create a new config with the required file path and sensible defaults.

pub fn delimiter(self, d: u8) -> CsvSinkConfig

Set the field delimiter byte.

pub fn write_headers(self, v: bool) -> CsvSinkConfig

Set whether to write a header row.

pub fn append(self, v: bool) -> CsvSinkConfig

Set whether to append to an existing file.

pub fn with_batch_size(self, batch_size: usize) -> CsvSinkConfig

Set the per-page record count hint reported alongside other sink configs.

This sink writes per-record through a buffered writer, so the value is observably a no-op: 0 (the “no batching” sentinel) and any positive value produce the same on-disk output. Present for symmetry with sinks whose batch_size does drive I/O sizing (e.g. SQL multi-row inserts, BigQuery streaming inserts).

pub fn compression(self, c: CompressionConfig) -> CsvSinkConfig

Available on crate feature compression only.

Set the compression codec. Available only with the compression feature.

Trait Implementations

impl Clone for CsvSinkConfig

fn clone(&self) -> CsvSinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CsvSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CsvSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CsvSinkConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for CsvSinkConfig

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.