nautilus_common/
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//! Common componentry for [NautilusTrader](http://nautilustrader.io).
17//!
18//! The `nautilus-common` crate provides shared components and utilities that form the system foundation for
19//! NautilusTrader applications. This includes the actor system, message bus, caching layer, and other
20//! essential services.
21//!
22//! # Platform
23//!
24//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
25//! algorithmic trading platform, providing quantitative traders with the ability to backtest
26//! portfolios of automated trading strategies on historical data with an event-driven engine,
27//! and also deploy those same strategies live, with no code changes.
28//!
29//! NautilusTrader's design, architecture, and implementation philosophy prioritizes software correctness and safety at the
30//! highest level, with the aim of supporting mission-critical, trading system backtesting and live deployment workloads.
31//!
32//! # Feature Flags
33//!
34//! This crate provides feature flags to control source code inclusion during compilation,
35//! depending on the intended use case, i.e. whether to provide Python bindings
36//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
37//! or as part of a Rust only build.
38//!
39//! - `ffi`: Enables the C foreign function interface (FFI) from [cbindgen](https://github.com/mozilla/cbindgen).
40//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
41//! - `defi`: Enables DeFi (Decentralized Finance) support.
42//! - `indicators`: Includes the `nautilus-indicators` crate and indicator utilities.
43//! - `capnp`: Enables [Cap'n Proto](https://capnproto.org/) serialization support.
44//! - `live`: Enables the Tokio async runtime for live trading.
45//! - `tracing-bridge`: Enables the `tracing` subscriber bridge for log integration.
46//! - `extension-module`: Builds the crate as a Python extension module.
47
48#![warn(rustc::all)]
49#![deny(unsafe_code)]
50#![deny(unsafe_op_in_unsafe_fn)]
51#![deny(nonstandard_style)]
52#![deny(missing_debug_implementations)]
53#![deny(clippy::missing_errors_doc)]
54#![deny(clippy::missing_panics_doc)]
55#![deny(rustdoc::broken_intra_doc_links)]
56
57pub mod actor;
58pub mod cache;
59pub mod clients;
60pub mod clock;
61pub mod component;
62pub mod custom;
63pub mod enums;
64pub mod factories;
65pub mod generators;
66pub mod greeks;
67pub mod logging;
68pub mod messages;
69pub mod msgbus;
70pub mod runner;
71pub mod signal;
72pub mod testing;
73pub mod throttler;
74pub mod timer;
75pub mod xrate;
76
77#[cfg(feature = "live")]
78pub mod live;
79
80#[cfg(feature = "defi")]
81pub mod defi;
82
83#[cfg(feature = "ffi")]
84pub mod ffi;
85
86#[cfg(feature = "python")]
87pub mod python;
88
89#[cfg(feature = "capnp")]
90pub mod serialization;
nautilus_common/lib.rs

nautilus_common/
lib.rs
