Struct ParxWriter 

pub struct ParxWriter { /* private fields */ }

Writer for PARX sidecar files.

Builds a PARX file from Parquet footer bytes and optional extensions.

Implementations

impl ParxWriter

pub fn new() -> Self

Create a new PARX writer.

pub fn from_parquet_bytes(data: &[u8]) -> Result<Self>

Create a writer pre-populated from in-memory Parquet bytes.

Validates the PAR1 magic, extracts the footer, and sets source_size.

pub fn from_parquet_file(path: impl AsRef<Path>) -> Result<Self>

Create a writer pre-populated from a Parquet file on disk.

Reads the file tail, validates PAR1 magic, extracts the footer, and sets both source_size and source_uri.

pub fn set_source_uri(&mut self, uri: impl Into<String>)

Set the source Parquet file URI (optional, informational).

pub fn set_source_size(&mut self, size: u64)

Set the source Parquet file size (required for validation).

pub fn set_footer(&mut self, bytes: &[u8])

Set the Parquet footer bytes to cache.

pub fn set_footer_owned(&mut self, bytes: impl Into<Bytes>)

Set the Parquet footer bytes to cache (move version, avoids copy when possible).

pub fn set_compression(&mut self, compression: Compression)

Set the compression algorithm for the footer.

pub fn clear_compression(&mut self)

Clear compression (store footer uncompressed).

pub fn auto_compress(&mut self)

Enable auto-compression if footer exceeds threshold.

Uses Zstd compression for footers larger than 10KB.

pub const fn compression(&self) -> Option<Compression>

Get the current compression setting.

pub const fn source_size(&self) -> u64

Get the source Parquet file size.

pub fn footer_size(&self) -> usize

Get the cached footer size in bytes.

pub fn set_page_indexes(&mut self, bytes: &[u8])

Set the page index bytes to cache.

Page indexes include ColumnIndex and OffsetIndex structures from Parquet V2. These are concatenated together in the order they appear in the file.

pub fn set_page_indexes_owned(&mut self, bytes: impl Into<Bytes>)

Set the page index bytes to cache (move version, avoids copy when possible).

pub fn has_page_indexes(&self) -> bool

Check if page indexes have been added.

pub fn finish(self) -> Vec<u8>

Build the PARX file bytes.

Layout:

• Header (16 bytes)
• Footer payload (variable, possibly compressed)
• Page index payload (variable, optional, possibly compressed)
• Manifest (variable, Protobuf)
• Trailer (12 bytes)

Panics

Panics if manifest exceeds 4GB.

Trait Implementations

impl Debug for ParxWriter

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

Formats the value using the given formatter.

impl Default for ParxWriter

fn default() -> Self

Returns the “default value” for a type.