Crate vortex_zstd 

Zstd-backed compression encodings for variable-width Vortex arrays.

ZstdArray stores UTF-8 or binary values as one or more zstd frames, optionally sharing a trained dictionary across frames. Frame metadata lets slices decompress only the frames that can contribute values to the requested row range.

ZstdBuffers stores the buffers of another encoding as independently compressed zstd buffers while preserving the inner encoding metadata.

This crate exposes array encodings only. Compression scheme selection is wired through vortex-btrblocks and file writing. To deserialize arrays manually, register the encoding in the array session:

use vortex_array::session::ArraySessionExt;

let session = vortex_array::array_session();
session.arrays().register(vortex_zstd::Zstd);

Modules

editions

The zstd edition family.

Structs

Zstd

Zstd array encoding marker.

ZstdBuffers

Encoding marker for buffer-level zstd compression.

ZstdBuffersData

An encoding that ZSTD-compresses the buffers of any wrapped array.

ZstdBuffersDecodePlan

Decode plan for buffer-level zstd decompression.

ZstdBuffersMetadata

Serialized metadata for the unstable ZstdBuffers encoding.

ZstdData

Encoding-specific data for a ZstdArray.

ZstdDataParts

Movable parts of a ZstdData value plus its validity.

ZstdFrameMetadata

Metadata for one zstd frame.

ZstdMetadata

Serialized metadata for a ZstdArray.

ZstdSlots

ZstdSlotsView

Borrowed view of ZstdSlots.

Traits

ZstdArraySlotsExt

Typed array accessors for Zstd.

Functions

initialize

Register the Zstd encodings and their optional edition declaration with a Vortex session.

reconstruct_views

Reconstruct BinaryView structs from length-prefixed byte data.

Type Aliases

ZstdArray

A Zstd-encoded Vortex array.

ZstdBuffersArray

A ZstdBuffers-encoded Vortex array.