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_legacy_ipc_format: bool

metadata_version: MetadataVersion

batch_compression_type: Option<CompressionType>

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.

Implementations

impl IpcWriteOptions

pub fn try_with_compression( self, batch_compression_type: Option<CompressionType>, ) -> Result<IpcWriteOptions, 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<IpcWriteOptions, 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) -> IpcWriteOptions

👎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<(), Error>

Formats the value using the given formatter.

impl Default for IpcWriteOptions

fn default() -> IpcWriteOptions

Returns the “default value” for a type.