parquet_variant/lib.rs
1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: See the NOTICE file distributed with this work for additional information regarding copyright ownership
3// SPDX-FileContributor: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements
4
5//! Implementation of [Variant Binary Encoding] from [Apache Parquet].
6//!
7//! [Variant Binary Encoding]: https://github.com/apache/parquet-format/blob/master/VariantEncoding.md
8//! [Apache Parquet]: https://parquet.apache.org/
9//!
10//! ## Main APIs
11//! - [`Variant`]: Represents a variant value, which can be an object, list, or primitive.
12//! - [`VariantBuilder`]: For building `Variant` values.
13//!
14//! ## 🚧 Work In Progress
15//!
16//! This crate is under active development and is not yet ready for production use.
17//! If you are interested in helping, you can find more information on the GitHub [Variant issue]
18//!
19//! [Variant issue]: https://github.com/apache/arrow-rs/issues/6736
20//!
21//! # Platform Support
22//!
23//! Only little-endian platforms are officially supported and tested in CI.
24//! Big-endian platforms are not tested in CI and may not work correctly.
25//! Fixes for big-endian platforms are welcome and handled on a best-effort basis,
26//! but compatibility is not guaranteed.
27
28mod builder;
29mod decoder;
30mod path;
31mod utils;
32mod variant;
33
34pub use arrow_schema::extension::VariantType;
35pub use builder::*;
36pub use path::{VariantPath, VariantPathElement};
37pub use variant::*;