nautilus_common/
lib.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 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//! - `stubs`: Enables type stubs for use in testing scenarios.
42//! - `defi`: Enables DeFi (Decentralized Finance) support.
43//! - `indicators`: Includes the `nautilus-indicators` crate and indicator utilities.
44//! - `extension-module`: Builds the crate as a Python extension module.
45
46#![warn(rustc::all)]
47#![deny(unsafe_code)]
48#![deny(unsafe_op_in_unsafe_fn)]
49#![deny(nonstandard_style)]
50#![deny(missing_debug_implementations)]
51#![deny(clippy::missing_errors_doc)]
52#![deny(clippy::missing_panics_doc)]
53#![deny(rustdoc::broken_intra_doc_links)]
54
55pub mod actor;
56pub mod cache;
57pub mod clock;
58pub mod component;
59pub mod custom;
60pub mod enums;
61pub mod factories;
62pub mod generators;
63pub mod greeks;
64pub mod logging;
65pub mod messages;
66pub mod msgbus;
67pub mod runner;
68pub mod runtime;
69pub mod signal;
70pub mod testing;
71pub mod throttler;
72pub mod timer;
73pub mod xrate;
74
75#[cfg(feature = "ffi")]
76pub mod ffi;
77
78#[cfg(feature = "python")]
79pub mod python;
nautilus_common/lib.rs

nautilus_common/
lib.rs
