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//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
17//! algorithmic trading platform, providing quantitative traders with the ability to backtest
18//! portfolios of automated trading strategies on historical data with an event-driven engine,
19//! and also deploy those same strategies live, with no code changes.
20//!
21//! # Feature flags
22//!
23//! This crate provides feature flags to control source code inclusion during compilation,
24//! depending on the intended use case, i.e. whether to provide Python bindings
25//! for the main `nautilus_trader` Python package, or as part of a Rust only build.
26//!
27//! - `ffi`: Enables the C foreign function interface (FFI) from `cbindgen`.
28//! - `python`: Enables Python bindings from `pyo3`.
29//! - `stubs`: Enables type stubs for use in testing scenarios.
30
31#![warn(rustc::all)]
32#![deny(nonstandard_style)]
33#![deny(rustdoc::broken_intra_doc_links)]
34// #![deny(clippy::missing_errors_doc)]
35
36// Uncomment once we've added trivial `Debug` impls everywhere
37// #![warn(missing_debug_implementations)]
38
39pub mod actor;
40pub mod cache;
41pub mod clock;
42pub mod component;
43pub mod custom;
44pub mod enums;
45pub mod factories;
46pub mod generators;
47pub mod logging;
48pub mod messages;
49pub mod msgbus;
50pub mod runner;
51pub mod runtime;
52pub mod signal;
53pub mod testing;
54pub mod throttler;
55pub mod timer;
56pub mod xrate;
57
58#[cfg(feature = "ffi")]
59pub mod ffi;
60
61#[cfg(feature = "python")]
62pub mod python;
nautilus_common/lib.rs

nautilus_common/
lib.rs
