Skip to main content

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//! - `ffi`: Enables the C foreign function interface (FFI) from [cbindgen](https://github.com/mozilla/cbindgen).
50//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
51//! - `extension-module`: Builds the crate as a Python extension module.
52
53#![warn(rustc::all)]
54#![warn(clippy::pedantic)]
55#![deny(unsafe_code)]
56#![deny(unsafe_op_in_unsafe_fn)]
57#![deny(nonstandard_style)]
58#![deny(missing_debug_implementations)]
59#![deny(clippy::missing_errors_doc)]
60#![deny(clippy::missing_panics_doc)]
61#![deny(rustdoc::broken_intra_doc_links)]
62#![allow(
63    clippy::similar_names,
64    reason = "execution domain terms such as ts_event/ts_init are intentionally parallel"
65)]
66#![allow(
67    clippy::cast_lossless,
68    clippy::cast_possible_truncation,
69    clippy::cast_possible_wrap,
70    clippy::cast_precision_loss,
71    clippy::cast_sign_loss,
72    reason = "execution math casts between i64/u64/usize/f64 with values bounded by domain ranges"
73)]
74#![allow(
75    clippy::must_use_candidate,
76    reason = "execution accessors and constructors are pervasive; #[must_use] noise is not warranted"
77)]
78#![allow(
79    clippy::unused_self,
80    reason = "engine and matching helpers take &self for method-style organization"
81)]
82#![allow(
83    clippy::large_types_passed_by_value,
84    reason = "command and report value types are intentionally moved through dispatch"
85)]
86#![allow(
87    clippy::unsafe_derive_deserialize,
88    reason = "config types deserialize plain field values; unrelated unsafe impls are sound"
89)]
90#![allow(
91    clippy::missing_fields_in_debug,
92    reason = "manual Debug impls intentionally omit verbose internal state"
93)]
94#![allow(
95    clippy::struct_excessive_bools,
96    reason = "config and snapshot structs mirror existing Python configuration surfaces"
97)]
98#![allow(
99    clippy::too_many_lines,
100    reason = "engine and matching dispatch functions exceed the default threshold by design"
101)]
102#![allow(
103    clippy::inline_always,
104    reason = "hot-path helpers in matching engine are intentionally always inlined"
105)]
106#![allow(
107    clippy::match_same_arms,
108    reason = "explicit per-variant arms document order/event dispatch even when bodies coincide"
109)]
110#![allow(
111    clippy::match_wildcard_for_single_variants,
112    reason = "wildcard arms guard against future enum variants in command dispatch"
113)]
114#![allow(
115    clippy::manual_let_else,
116    reason = "match-with-early-return is consistent with surrounding engine and reconciliation code"
117)]
118#![allow(
119    clippy::single_match_else,
120    reason = "two-arm matches are consistent with surrounding command and event dispatch"
121)]
122#![cfg_attr(
123    test,
124    allow(
125        clippy::default_trait_access,
126        clippy::float_cmp,
127        clippy::should_panic_without_expect,
128        clippy::unreadable_literal,
129        clippy::used_underscore_binding,
130        reason = "execution tests assert exact float outputs and use loose patterns for fixture setup"
131    )
132)]
133
134pub mod client;
135pub mod engine;
136pub mod matching_core;
137pub mod matching_engine;
138pub mod models;
139pub mod order_emulator;
140pub mod order_manager;
141pub mod protection;
142pub mod reconciliation;
143pub mod trailing;
144
145#[cfg(feature = "python")]
146pub mod python;