nautilus_model/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 [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
26//! or as part of a Rust only build.
27//!
28//! - `ffi`: Enables the C foreign function interface (FFI) from [cbindgen](https://github.com/mozilla/cbindgen).
29//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
30//! - `stubs`: Enables type stubs for use in testing scenarios.
31//! - `high-precision`: Enables [high-precision mode](https://nautilustrader.io/docs/nightly/getting_started/installation#precision-mode) to use 128-bit value types.
32
33#![warn(rustc::all)]
34#![deny(nonstandard_style)]
35#![deny(rustdoc::broken_intra_doc_links)]
36// #![deny(clippy::missing_errors_doc)]
37
38pub mod accounts;
39pub mod currencies;
40pub mod data;
41pub mod enums;
42pub mod events;
43pub mod identifiers;
44pub mod instruments;
45pub mod macros;
46pub mod orderbook;
47pub mod orders;
48pub mod position;
49pub mod types;
50pub mod venues;
51
52#[cfg(feature = "ffi")]
53pub mod ffi;
54
55#[cfg(feature = "python")]
56pub mod python;
57
58#[cfg(feature = "stubs")]
59pub mod stubs;