Struct EncodingOptions

pub struct EncodingOptions {
    pub cache_bytes_per_column: u64,
    pub max_page_bytes: u64,
    pub keep_original_array: bool,
    pub buffer_alignment: u64,
}

Options that control the encoding process

Fields

cache_bytes_per_column: u64

How much data (in bytes) to cache in-memory before writing a page

This cache is applied on a per-column basis

max_page_bytes: u64

The maximum size of a page in bytes, if a single array would create a page larger than this then it will be split into multiple pages

keep_original_array: bool

If false (the default) then arrays will be copied (deeply) before being cached. This ensures any data kept alive by the array can be discarded safely and helps avoid writer accumulation. However, there is an associated cost.

buffer_alignment: u64

The alignment that the writer is applying to buffers

The encoder needs to know this so it figures the position of out-of-line buffers correctly

Trait Implementations

impl Default for EncodingOptions

fn default() -> Self

Returns the “default value” for a type.