nautilus_core/consts.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//! Core constants.
17
18/// The NautilusTrader string constant.
19pub static NAUTILUS_TRADER: &str = "NautilusTrader";
20
21/// The `nautilus-core` crate version string embedded at compile time.
22pub static NAUTILUS_VERSION_CORE: &str = env!("CARGO_PKG_VERSION");
23
24/// The NautilusTrader version string selected for the compiled application.
25pub static NAUTILUS_VERSION: &str = if cfg!(feature = "python") {
26 env!("NAUTILUS_VERSION")
27} else {
28 NAUTILUS_VERSION_CORE
29};
30
31/// The NautilusTrader common User-Agent string including the current version at compile time.
32pub static NAUTILUS_USER_AGENT: &str = if cfg!(feature = "python") {
33 env!("NAUTILUS_USER_AGENT")
34} else {
35 concat!("NautilusTrader/", env!("CARGO_PKG_VERSION"))
36};
37
38/// Prefix for log messages outside the main logging subsystem.
39pub static NAUTILUS_PREFIX: &str = "[NAUTILUS]";
40
41#[cfg(test)]
42mod tests {
43 use rstest::rstest;
44
45 use super::*;
46
47 #[cfg(not(feature = "python"))]
48 #[rstest]
49 fn test_nautilus_versions_rust() {
50 assert_eq!(NAUTILUS_VERSION_CORE, env!("CARGO_PKG_VERSION"));
51 assert_eq!(NAUTILUS_VERSION, env!("CARGO_PKG_VERSION"));
52 assert_eq!(
53 NAUTILUS_USER_AGENT,
54 concat!("NautilusTrader/", env!("CARGO_PKG_VERSION")),
55 );
56 }
57
58 #[cfg(feature = "python")]
59 #[rstest]
60 fn test_nautilus_versions_python() {
61 assert_eq!(NAUTILUS_VERSION_CORE, env!("CARGO_PKG_VERSION"));
62 assert_eq!(NAUTILUS_VERSION, env!("NAUTILUS_VERSION"));
63 assert_eq!(NAUTILUS_USER_AGENT, env!("NAUTILUS_USER_AGENT"));
64 }
65}