nautilus_data/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3// https://nautechsystems.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 engine and market data processing for [NautilusTrader](https://nautilustrader.io).
17//!
18//! The `nautilus-data` crate provides a framework for handling market data ingestion,
19//! processing, and aggregation within the NautilusTrader ecosystem. This includes real-time
20//! data streaming, historical data management, and various aggregation methodologies:
21//!
22//! - High-performance data engine for orchestrating data operations.
23//! - Data client infrastructure for connecting to market data providers.
24//! - Bar aggregation machinery supporting tick, volume, value, and time-based aggregation.
25//! - Order book management and delta processing capabilities.
26//! - Subscription management and data request handling.
27//! - Configurable data routing and processing pipelines.
28//!
29//! # NautilusTrader
30//!
31//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
32//! engine for multi-asset, multi-venue trading systems.
33//!
34//! The system spans research, deterministic simulation, and live execution within a single
35//! event-driven architecture, providing research-to-live semantic parity.
36//!
37//! # Feature Flags
38//!
39//! This crate provides feature flags to control source code inclusion during compilation,
40//! depending on the intended use case, i.e. whether to provide Python bindings
41//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
42//! or as part of a Rust only build.
43//!
44//! - `defi`: Enables DeFi (Decentralized Finance) support.
45//! - `extension-module`: Enables Python extension-module support.
46//! - `high-precision`: Enables
47//! [high-precision mode](https://nautilustrader.io/docs/nightly/getting_started/installation/#precision-mode)
48//! to use 128-bit value types.
49//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
50//! - `streaming`: Enables the `nautilus-persistence` dependency for catalog-based data streaming.
51
52#![warn(rustc::all)]
53#![warn(clippy::pedantic)]
54#![warn(clippy::clone_on_ref_ptr)]
55#![deny(unsafe_code)]
56#![deny(unsafe_op_in_unsafe_fn)]
57#![deny(nonstandard_style)]
58#![deny(missing_debug_implementations)]
59#![deny(clippy::missing_errors_doc)]
60#![deny(clippy::missing_panics_doc)]
61#![deny(rustdoc::broken_intra_doc_links)]
62#![allow(
63 clippy::similar_names,
64 reason = "data domain terms such as ts_event/ts_init are intentionally parallel"
65)]
66#![allow(
67 clippy::cast_lossless,
68 clippy::cast_possible_truncation,
69 clippy::cast_possible_wrap,
70 clippy::cast_precision_loss,
71 clippy::cast_sign_loss,
72 reason = "data math casts between i64/u64/usize/f64 with values bounded by domain ranges"
73)]
74#![allow(
75 clippy::must_use_candidate,
76 reason = "data accessors are pervasive; #[must_use] noise is not warranted"
77)]
78#![allow(
79 clippy::unused_self,
80 reason = "engine operations take &self for method-style organization"
81)]
82#![allow(
83 clippy::large_types_passed_by_value,
84 reason = "command and request value types are intentionally moved through dispatch"
85)]
86#![allow(
87 clippy::unsafe_derive_deserialize,
88 reason = "config types deserialize plain field values; unrelated unsafe impls are sound"
89)]
90#![allow(
91 clippy::missing_fields_in_debug,
92 reason = "manual Debug impls intentionally omit verbose internal state"
93)]
94#![allow(
95 clippy::struct_excessive_bools,
96 reason = "config structs mirror existing Python configuration surfaces"
97)]
98#![allow(
99 clippy::too_many_lines,
100 reason = "engine and aggregation dispatch functions exceed the default threshold by design"
101)]
102#![allow(
103 clippy::inline_always,
104 reason = "hot-path aggregation functions are intentionally always inlined"
105)]
106#![allow(
107 clippy::match_same_arms,
108 reason = "explicit per-variant arms document data dispatch even when bodies coincide"
109)]
110#![allow(
111 clippy::match_wildcard_for_single_variants,
112 reason = "wildcard arms guard against future enum variants in command dispatch"
113)]
114#![allow(
115 clippy::single_match_else,
116 reason = "two-arm matches are consistent with surrounding command and event dispatch"
117)]
118#![allow(
119 clippy::assert_is_empty,
120 reason = "`assert!(x.is_empty())` is clearer than comparing against an empty value"
121)]
122#![cfg_attr(
123 test,
124 allow(
125 clippy::float_cmp,
126 clippy::should_panic_without_expect,
127 clippy::unreadable_literal,
128 clippy::used_underscore_binding,
129 reason = "data tests assert exact float outputs and use loose patterns for fixture setup"
130 )
131)]
132
133pub mod aggregation;
134pub mod client;
135pub mod engine;
136pub mod option_chains;
137#[doc(hidden)]
138pub mod replay;
139
140#[cfg(feature = "python")]
141pub mod python;
142
143#[cfg(feature = "defi")]
144pub mod defi;
145
146mod subscription;
147
148// Re-exports
149pub use aggregation::{
150 FixedTickSchemeRounder, MapVegaProvider, SpreadPriceRounder, SpreadQuoteAggregator,
151 VegaProvider,
152};
153pub use client::DataClientAdapter;