Struct IpcWriteOptions

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

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

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

Trait Implementations

impl Clone for IpcWriteOptions

fn clone(&self) -> IpcWriteOptions

Returns a duplicate 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.