nautilus_model/identifiers/
venue.rs

Help
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//! Represents a valid trading venue ID.
17
18use std::{
19    fmt::{Debug, Display, Formatter},
20    hash::Hash,
21};
22
23use nautilus_core::correctness::{FAILED, check_valid_string};
24use ustr::Ustr;
25
26use crate::venues::VENUE_MAP;
27
28pub const SYNTHETIC_VENUE: &str = "SYNTH";
29
30/// Represents a valid trading venue ID.
31#[repr(C)]
32#[derive(Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
33#[cfg_attr(
34    feature = "python",
35    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.model")
36)]
37pub struct Venue(Ustr);
38
39impl Venue {
40    /// Creates a new [`Venue`] instance with correctness checking.
41    ///
42    /// # Errors
43    ///
44    /// This function returns an error:
45    /// - If `value` is not a valid string.
46    ///
47    /// # Notes
48    ///
49    /// PyO3 requires a `Result` type for proper error handling and stacktrace printing in Python.
50    pub fn new_checked<T: AsRef<str>>(value: T) -> anyhow::Result<Self> {
51        let value = value.as_ref();
52        check_valid_string(value, stringify!(value))?;
53        Ok(Self(Ustr::from(value)))
54    }
55
56    /// Creates a new [`Venue`] instance.
57    ///
58    /// # Panics
59    ///
60    /// This function panics:
61    /// - If `value` is not a valid string.
62    pub fn new<T: AsRef<str>>(value: T) -> Self {
63        Self::new_checked(value).expect(FAILED)
64    }
65
66    /// Sets the inner identifier value.
67    #[allow(dead_code)]
68    pub(crate) fn set_inner(&mut self, value: &str) {
69        self.0 = Ustr::from(value);
70    }
71
72    /// Returns the inner identifier value.
73    #[must_use]
74    pub fn inner(&self) -> Ustr {
75        self.0
76    }
77
78    /// Returns the inner value as a string slice.
79    #[must_use]
80    pub fn as_str(&self) -> &str {
81        self.0.as_str()
82    }
83
84    #[must_use]
85    pub fn from_str_unchecked<T: AsRef<str>>(s: T) -> Self {
86        Self(Ustr::from(s.as_ref()))
87    }
88
89    #[must_use]
90    pub const fn from_ustr_unchecked(s: Ustr) -> Self {
91        Self(s)
92    }
93
94    pub fn from_code(code: &str) -> anyhow::Result<Self> {
95        let map_guard = VENUE_MAP
96            .lock()
97            .map_err(|e| anyhow::anyhow!("Error acquiring lock on `VENUE_MAP`: {e}"))?;
98        map_guard
99            .get(code)
100            .copied()
101            .ok_or_else(|| anyhow::anyhow!("Unknown venue code: {code}"))
102    }
103
104    #[must_use]
105    pub fn synthetic() -> Self {
106        // SAFETY: Unwrap safe as using known synthetic venue constant
107        Self::new(SYNTHETIC_VENUE)
108    }
109
110    #[must_use]
111    pub fn is_synthetic(&self) -> bool {
112        self.0.as_str() == SYNTHETIC_VENUE
113    }
114}
115
116impl Debug for Venue {
117    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
118        write!(f, "{:?}", self.0)
119    }
120}
121
122impl Display for Venue {
123    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
124        write!(f, "{}", self.0)
125    }
126}
127
128////////////////////////////////////////////////////////////////////////////////
129// Tests
130////////////////////////////////////////////////////////////////////////////////
131#[cfg(test)]
132mod tests {
133    use rstest::rstest;
134
135    use crate::identifiers::{Venue, stubs::*};
136
137    #[rstest]
138    fn test_string_reprs(venue_binance: Venue) {
139        assert_eq!(venue_binance.as_str(), "BINANCE");
140        assert_eq!(format!("{venue_binance}"), "BINANCE");
141    }
142}
nautilus_model/identifiers/venue.rs

nautilus_model/identifiers/
venue.rs
