nautilus_execution/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//! Order execution system for [NautilusTrader](https://nautilustrader.io).
17//!
18//! The `nautilus-execution` crate provides an order execution system that handles the complete
19//! order lifecycle from submission to fill processing. This includes sophisticated order matching,
20//! execution venue integration, and advanced order type emulation:
21//!
22//! - **Execution engine**: Central orchestration of order routing and position management.
23//! - **Order matching engine**: High-fidelity market simulation for backtesting and paper trading.
24//! - **Order emulator**: Advanced order types not natively supported by venues (trailing stops, contingent orders).
25//! - **Execution clients**: Abstract interfaces for connecting to trading venues and brokers.
26//! - **Order manager**: Local order lifecycle management and state tracking.
27//! - **Matching core**: Low-level order book and price-time priority matching algorithms.
28//! - **Fee and fill models**: Configurable execution cost simulation and realistic fill behavior.
29//!
30//! The crate supports both live trading environments (with real execution clients) and simulated
31//! environments (with matching engines), making it suitable for production trading, strategy
32//! development, and backtesting.
33//!
34//! # NautilusTrader
35//!
36//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
37//! engine for multi-asset, multi-venue trading systems.
38//!
39//! The system spans research, deterministic simulation, and live execution within a single
40//! event-driven architecture, providing research-to-live semantic parity.
41//!
42//! # Feature Flags
43//!
44//! This crate provides feature flags to control source code inclusion during compilation,
45//! depending on the intended use case, i.e. whether to provide Python bindings
46//! for the [nautilus_trader](https://pypi.org/project/nautilus_trader) Python package,
47//! or as part of a Rust only build.
48//!
49//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
50//! - `extension-module`: Builds the crate as a Python extension module.
51
52#![warn(rustc::all)]
53#![warn(clippy::pedantic)]
54#![deny(unsafe_code)]
55#![deny(unsafe_op_in_unsafe_fn)]
56#![deny(nonstandard_style)]
57#![deny(missing_debug_implementations)]
58#![deny(clippy::missing_errors_doc)]
59#![deny(clippy::missing_panics_doc)]
60#![deny(rustdoc::broken_intra_doc_links)]
61#![allow(
62 clippy::similar_names,
63 reason = "execution domain terms such as ts_event/ts_init are intentionally parallel"
64)]
65#![allow(
66 clippy::cast_lossless,
67 clippy::cast_possible_truncation,
68 clippy::cast_possible_wrap,
69 clippy::cast_precision_loss,
70 clippy::cast_sign_loss,
71 reason = "execution math casts between i64/u64/usize/f64 with values bounded by domain ranges"
72)]
73#![allow(
74 clippy::must_use_candidate,
75 reason = "execution accessors and constructors are pervasive; #[must_use] noise is not warranted"
76)]
77#![allow(
78 clippy::unused_self,
79 reason = "engine and matching helpers take &self for method-style organization"
80)]
81#![allow(
82 clippy::large_types_passed_by_value,
83 reason = "command and report value types are intentionally moved through dispatch"
84)]
85#![allow(
86 clippy::unsafe_derive_deserialize,
87 reason = "config types deserialize plain field values; unrelated unsafe impls are sound"
88)]
89#![allow(
90 clippy::missing_fields_in_debug,
91 reason = "manual Debug impls intentionally omit verbose internal state"
92)]
93#![allow(
94 clippy::struct_excessive_bools,
95 reason = "config and snapshot structs mirror existing Python configuration surfaces"
96)]
97#![allow(
98 clippy::too_many_lines,
99 reason = "engine and matching dispatch functions exceed the default threshold by design"
100)]
101#![allow(
102 clippy::inline_always,
103 reason = "hot-path helpers in matching engine are intentionally always inlined"
104)]
105#![allow(
106 clippy::match_same_arms,
107 reason = "explicit per-variant arms document order/event dispatch even when bodies coincide"
108)]
109#![allow(
110 clippy::match_wildcard_for_single_variants,
111 reason = "wildcard arms guard against future enum variants in command dispatch"
112)]
113#![allow(
114 clippy::manual_let_else,
115 reason = "match-with-early-return is consistent with surrounding engine and reconciliation code"
116)]
117#![allow(
118 clippy::single_match_else,
119 reason = "two-arm matches are consistent with surrounding command and event dispatch"
120)]
121#![allow(
122 clippy::assert_is_empty,
123 reason = "`assert!(x.is_empty())` is clearer than comparing against an empty value"
124)]
125#![cfg_attr(
126 test,
127 allow(
128 clippy::default_trait_access,
129 clippy::float_cmp,
130 clippy::should_panic_without_expect,
131 clippy::unreadable_literal,
132 clippy::used_underscore_binding,
133 reason = "execution tests assert exact float outputs and use loose patterns for fixture setup"
134 )
135)]
136
137pub mod client;
138pub mod engine;
139pub mod matching_core;
140pub mod matching_engine;
141pub mod models;
142pub mod order_emulator;
143pub mod order_manager;
144pub mod protection;
145pub mod reconciliation;
146pub mod trailing;
147
148#[cfg(feature = "python")]
149pub mod python;