Struct IpcWriteOptions

pub struct IpcWriteOptions {
    alignment: u8,
    write_legacy_ipc_format: bool,
    metadata_version: MetadataVersion,
    batch_compression_type: Option<CompressionType>,
    preserve_dict_id: bool,
}

IPC write options used to control the behaviour of the IpcDataGenerator

Fields

alignment: u8

Write padding after memory buffers to this multiple of bytes. Must be 8, 16, 32, or 64 - defaults to 64.

write_legacy_ipc_format: bool

The legacy format is for releases before 0.15.0, and uses metadata V4

metadata_version: MetadataVersion

The metadata version to write. The Rust IPC writer supports V4+

Default versions per crate

When creating the default IpcWriteOptions, the following metadata versions are used:

version 2.0.0: V4, with legacy format enabled version 4.0.0: V5

batch_compression_type: Option<CompressionType>

Compression, if desired. Will result in a runtime error if the corresponding feature is not enabled

preserve_dict_id: bool

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all fields related to it.

Flag indicating whether the writer should preserve the dictionary IDs defined in the schema or generate unique dictionary IDs internally during encoding.

Defaults to false

Implementations

impl IpcWriteOptions

pub fn try_with_compression( self, batch_compression_type: Option<CompressionType>, ) -> Result<Self, ArrowError>

Configures compression when writing IPC files.

Will result in a runtime error if the corresponding feature is not enabled

pub fn try_new( alignment: usize, write_legacy_ipc_format: bool, metadata_version: MetadataVersion, ) -> Result<Self, ArrowError>

Try to create IpcWriteOptions, checking for incompatible settings

pub fn preserve_dict_id(&self) -> bool

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all functions related to it.

Return whether the writer is configured to preserve the dictionary IDs defined in the schema

pub fn with_preserve_dict_id(self, preserve_dict_id: bool) -> Self

👎Deprecated since 54.0.0: The ability to preserve dictionary IDs will be removed. With it, all functions related to it.

Set whether the IPC writer should preserve the dictionary IDs in the schema or auto-assign unique dictionary IDs during encoding (defaults to true)

If this option is true, the application must handle assigning ids to the dictionary batches in order to encode them correctly

The default will change to false in future releases

Trait Implementations

impl Clone for IpcWriteOptions

fn clone(&self) -> IpcWriteOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IpcWriteOptions

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

Formats the value using the given formatter.

impl Default for IpcWriteOptions

fn default() -> Self

Returns the “default value” for a type.