nautilus_serialization/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 Posei Systems Pty Ltd. All rights reserved.
3// https://poseitrader.io
4//
5// Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6// You may not use this file except in compliance with the License.
7// You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Data serialization and format conversion for [PoseiTrader](http://poseitrader.io).
17//!
18//! The *serialization* crate provides comprehensive data serialization capabilities for converting
19//! trading data between different formats including Apache Arrow, Parquet, and custom schemas.
20//! This enables efficient data storage, retrieval, and interoperability across different systems:
21//!
22//! - **Apache Arrow integration**: Schema definitions and encoding/decoding for market data types.
23//! - **Parquet file operations**: High-performance columnar storage for historical data analysis.
24//! - **Record batch processing**: Efficient batch operations for time-series data.
25//! - **Schema management**: Type-safe schema definitions with metadata preservation.
26//! - **Cross-format conversion**: Seamless data interchange between Arrow, Parquet, and native types.
27//!
28//! # Feature flags
29//!
30//! This crate provides feature flags to control source code inclusion during compilation,
31//! depending on the intended use case, i.e. whether to provide Python bindings
32//! for the [posei_trader](https://pypi.org/project/posei_trader) Python package,
33//! or as part of a Rust only build.
34//!
35//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
36//! - `high-precision`: Enables [high-precision mode](docs/latestnightly/getting_started/installation#precision-mode) to use 128-bit value types.
37
38#![warn(rustc::all)]
39#![deny(unsafe_code)]
40#![deny(nonstandard_style)]
41#![deny(missing_debug_implementations)]
42#![deny(clippy::missing_errors_doc)]
43#![deny(clippy::missing_panics_doc)]
44#![deny(rustdoc::broken_intra_doc_links)]
45
46pub mod arrow;
47
48#[cfg(feature = "python")]
49pub mod python;