Skip to main content

parx_rs/
lib.rs

1/*
2 * Copyright 2026 PARX Authors
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16//! PARX Core Library
17//!
18//! This crate provides the core functionality for reading and writing PARX sidecar files.
19//! PARX files cache Parquet footer metadata to accelerate query planning on object stores.
20
21mod bundle;
22mod compression;
23mod error;
24mod format;
25mod reader;
26mod writer;
27
28pub mod proto {
29    include!("parx.rs");
30}
31
32pub use bundle::{ParxBundleReader, ParxBundleWriter, BUNDLE_FILENAME};
33pub use compression::{compress, decompress};
34pub use error::{ParxError, Result};
35pub use format::Compression;
36pub use format::{
37    BundleHeader, Header, Trailer, BUNDLE_HEADER_SIZE, HEADER_SIZE, TRAILER_SIZE, VERSION_MAJOR,
38    VERSION_MINOR,
39};
40pub use proto::{BundleEntry, ParxBundle, ParxManifest};
41pub use reader::ParxReader;
42pub use writer::ParxWriter;