parquet_variant/lib.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18//! Implementation of [Variant Binary Encoding] from [Apache Parquet].
19//!
20//! [Variant Binary Encoding]: https://github.com/apache/parquet-format/blob/master/VariantEncoding.md
21//! [Apache Parquet]: https://parquet.apache.org/
22//!
23//! ## Main APIs
24//! - [`Variant`]: Represents a variant value, which can be an object, list, or primitive.
25//! - [`VariantBuilder`]: For building `Variant` values.
26//!
27//! ## 🚧 Work In Progress
28//!
29//! This crate is under active development and is not yet ready for production use.
30//! If you are interested in helping, you can find more information on the GitHub [Variant issue]
31//!
32//! [Variant issue]: https://github.com/apache/arrow-rs/issues/6736
33//!
34//! # Platform Support
35//!
36//! Only little-endian platforms are officially supported and tested in CI.
37//! Big-endian platforms are not tested in CI and may not work correctly.
38//! Fixes for big-endian platforms are welcome and handled on a best-effort basis,
39//! but compatibility is not guaranteed.
40
41mod builder;
42mod decoder;
43mod path;
44mod utils;
45mod variant;
46
47pub use builder::*;
48pub use path::{VariantPath, VariantPathElement};
49pub use variant::*;