Enum CompressionCodec 

pub enum CompressionCodec {
    Lz4Frame,
    Zstd(i32),
}

Represents compressing a ipc stream using a particular compression algorithm

Variants

Lz4Frame

Zstd(i32)

Implementations

impl CompressionCodec

pub(crate) fn try_new_with_compression_level( compression_type: CompressionType, compression_level: i32, ) -> Result<Self, ArrowError>

Creates a CompressionCodec with an explicit compression level.

The level is used for CompressionType::ZSTD. CompressionType::LZ4_FRAME does not yet support compression levels and ignores this value. Returns an error for unsupported compression types.

pub(crate) fn compress_to_vec( &self, input: &[u8], output: &mut Vec<u8>, context: &mut IpcWriteContext, ) -> Result<usize, ArrowError>

Compresses the data in input to output and appends the data using the specified compression mechanism.

returns the number of bytes written to the stream

Writes this format to output:

[8 bytes]:         uncompressed length
[remaining bytes]: compressed data stream

pub(crate) fn decompress_to_buffer( &self, input: &Buffer, context: &mut DecompressionContext, ) -> Result<Buffer, ArrowError>

Decompresses the input into a [Buffer]

The input should look like:

[8 bytes]:         uncompressed length
[remaining bytes]: compressed data stream

fn compress( &self, input: &[u8], output: &mut Vec<u8>, context: &mut IpcWriteContext, ) -> Result<(), ArrowError>

Compress the data in input buffer and write to output buffer using the specified compression

fn decompress( &self, input: &[u8], decompressed_size: usize, context: &mut DecompressionContext, ) -> Result<Vec<u8>, ArrowError>

Decompress the data in input buffer and write to output buffer using the specified compression

Trait Implementations

impl Clone for CompressionCodec

fn clone(&self) -> CompressionCodec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompressionCodec

impl Debug for CompressionCodec

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

Formats the value using the given formatter.

impl Eq for CompressionCodec

impl PartialEq for CompressionCodec

fn eq(&self, other: &CompressionCodec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CompressionCodec

impl TryFrom<CompressionType> for CompressionCodec

type Error = ArrowError

The type returned in the event of a conversion error.

fn try_from(compression_type: CompressionType) -> Result<Self, ArrowError>

Performs the conversion.