Struct CopyOptions 

pub struct CopyOptions { /* private fields */ }

Options for COPY text format operations (CSV, TSV, etc.).

Example

use hyperdb_api::copy::CopyOptions;

// CSV with header
let opts = CopyOptions::csv().with_header(true);

// TSV (tab-separated)
let opts = CopyOptions::tsv();

// Custom delimiter
let opts = CopyOptions::csv().with_delimiter(b'|');

Implementations

impl CopyOptions

pub fn csv() -> Self

Creates CSV format options (comma-separated, no header by default).

pub fn tsv() -> Self

Creates TSV format options (tab-separated).

pub fn text() -> Self

Creates plain text format options (tab-separated, Hyper default).

pub fn with_header(self, header: bool) -> Self

Enables or disables the header row.

pub fn with_delimiter(self, delimiter: u8) -> Self

Sets the column delimiter character.

pub fn with_null(self, null_string: impl Into<String>) -> Self

Sets the string used to represent NULL values.

pub fn with_quote(self, quote: u8) -> Self

Sets the quote character for CSV format.

pub fn with_escape(self, escape: u8) -> Self

Sets the escape character for CSV format.

pub fn with_chunk_size(self, size: usize) -> Self

Sets the import chunk size in bytes.

Controls the buffer size used when streaming data from a reader during import_text(). Larger values reduce syscall overhead but use more memory.

Default is 1 MB. Typical range: 64 KB to 16 MB.

Panics

Panics if size is 0.

Trait Implementations

impl Clone for CopyOptions

fn clone(&self) -> CopyOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopyOptions

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

Formats the value using the given formatter.