Struct ParxReader 

pub struct ParxReader { /* private fields */ }

Reader for PARX sidecar files.

Parses and validates PARX files, providing access to the cached Parquet footer bytes and optional page index data.

Implementations

impl ParxReader

pub fn open(bytes: &[u8]) -> Result<Self>

Open a PARX file from bytes.

This validates the file structure, checksums, and extracts the manifest, footer payload, and optional page index data.

Errors

Returns error if file is invalid or corrupted.

Panics

Panics if file size is less than minimum header size.

pub fn open_bytes(bytes: &Bytes) -> Result<Self>

Open a PARX file from owned Bytes (zero-copy where possible). Use this when you already have Bytes (e.g., from object_store) to potentially reduce allocations.

Errors

Returns error if file is invalid or corrupted.

pub const fn header(&self) -> &Header

Get the parsed header.

pub const fn manifest(&self) -> &ParxManifest

Get the parsed manifest.

pub fn footer_bytes(&self) -> &[u8]

Get the cached Parquet footer bytes (decompressed if necessary).

pub const fn is_compressed(&self) -> bool

Check if the footer was stored compressed.

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

Get the compression algorithm used, if any.

pub const fn uncompressed_footer_size(&self) -> u64

Get the original uncompressed footer size.

Returns 0 if footer was not compressed.

pub const fn has_page_indexes(&self) -> bool

Check if this PARX file contains page index data.

pub fn page_index_bytes(&self) -> Option<&[u8]>

Get raw page index payload bytes, if present (decompressed).

Page indexes include concatenated ColumnIndex and OffsetIndex structures from Parquet V2 format.

pub const fn uncompressed_page_index_size(&self) -> u64

Get the original uncompressed page index size.

Returns 0 if page indexes were not compressed.

pub const fn validate_source_size(&self, source_size: u64) -> bool

Validate that this PARX file matches the given Parquet file size.

This is the fast validation check that should always be performed before using cached footer bytes.

pub fn validate_source_footer(&self, original_footer: &[u8]) -> bool

Validate that this PARX file matches the given Parquet footer hash.

This is the paranoid validation check that re-hashes the original Parquet footer bytes. Only use when you have the original footer.

pub fn source_uri(&self) -> &str

Get the source URI from the manifest (may be empty).

pub const fn source_size(&self) -> u64

Get the source file size from the manifest.

pub const fn created_at_ms(&self) -> u64

Get the creation timestamp in milliseconds.

Trait Implementations

impl Clone for ParxReader

fn clone(&self) -> ParxReader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParxReader

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

Formats the value using the given formatter.