nautilus_trader/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//! Workspace shim crate for *NautilusTrader*.
17//!
18//! This crate does **not** expose any public API of its own – it exists solely so that the root
19//! `crates/` directory is a valid Cargo crate. Having a real compilation unit prevents Cargo
20//! from discarding incremental build artefacts for the workspace when only the dependency graph
21//! changes, which in turn keeps rebuild times predictable.
22//!
23//! Because downstream users should never depend on this shim directly, the crate is marked
24//! `publish = false` in its `Cargo.toml`.
25//!
26//! If you are looking for the public entry-points of NautilusTrader, refer to the individual crates
27//! under `crates/*` such as `nautilus-core`, `nautilus-model`, `nautilus-backtest`, etc.
28
29// This minimal crate (with a placeholder `src/` and `Cargo.toml`) ensures Cargo treats it as a
30// valid compilation unit. Without these placeholders, Cargo might skip or rebuild this directory
31// in a way that forces other crates to rebuild. By including a “dummy” crate, we keep the build
32// cache fresh and avoid unnecessary full rebuilds.