nautilus_model/identifiers/
position_id.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//! Represents a valid position ID.
17
18use std::{
19    fmt::{Debug, Display},
20    hash::Hash,
21};
22
23use nautilus_core::correctness::{
24    CorrectnessResult, CorrectnessResultExt, FAILED, check_valid_string_utf8,
25};
26use ustr::Ustr;
27
28/// Represents a valid position ID.
29#[repr(C)]
30#[derive(Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
31#[cfg_attr(
32    feature = "python",
33    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.model", from_py_object)
34)]
35#[cfg_attr(
36    feature = "python",
37    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
38)]
39pub struct PositionId(Ustr);
40
41impl PositionId {
42    /// Creates a new [`PositionId`] instance with correctness checking.
43    ///
44    /// # Errors
45    ///
46    /// Returns an error if `value` is not a valid string.
47    ///
48    /// # Notes
49    ///
50    /// PyO3 requires a `Result` type for proper error handling and stacktrace printing in Python.
51    pub fn new_checked<T: AsRef<str>>(value: T) -> CorrectnessResult<Self> {
52        let value = value.as_ref();
53        check_valid_string_utf8(value, stringify!(value))?;
54        Ok(Self(Ustr::from(value)))
55    }
56
57    /// Creates a new [`PositionId`] instance.
58    ///
59    /// # Panics
60    ///
61    /// Panics if `value` is not a valid string.
62    pub fn new<T: AsRef<str>>(value: T) -> Self {
63        Self::new_checked(value).expect_display(FAILED)
64    }
65
66    /// Sets the inner identifier value.
67    #[cfg_attr(not(feature = "python"), 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 identifier value as a string slice.
79    #[must_use]
80    pub fn as_str(&self) -> &str {
81        self.0.as_str()
82    }
83
84    /// Checks if the position ID is virtual.
85    ///
86    /// Returns `true` if the position ID starts with "P-", otherwise `false`.
87    #[must_use]
88    pub fn is_virtual(&self) -> bool {
89        self.0.starts_with("P-")
90    }
91}
92
93impl Debug for PositionId {
94    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
95        write!(f, "\"{}\"", self.0)
96    }
97}
98impl Display for PositionId {
99    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
100        write!(f, "{}", self.0)
101    }
102}
103
104#[cfg(test)]
105mod tests {
106    use rstest::rstest;
107
108    use super::PositionId;
109    use crate::identifiers::stubs::*;
110
111    #[rstest]
112    fn test_string_reprs(position_id_test: PositionId) {
113        assert_eq!(position_id_test.as_str(), "P-123456789");
114        assert_eq!(format!("{position_id_test}"), "P-123456789");
115    }
116
117    #[rstest]
118    #[should_panic(expected = "Condition failed: invalid string for 'value', was empty")]
119    fn test_new_with_empty_string_panics_with_display_format() {
120        let _ = PositionId::new("");
121    }
122
123    #[rstest]
124    fn test_deserialize_json_with_unicode_escapes() {
125        let id: PositionId = serde_json::from_str(r#""P-\u9f99\u867e-1""#).unwrap();
126        assert_eq!(id.as_str(), "P-\u{9f99}\u{867e}-1");
127    }
128
129    #[rstest]
130    fn test_serialization_roundtrip_non_ascii() {
131        let id = PositionId::new("P-\u{9f99}\u{867e}-1");
132        let json = serde_json::to_string(&id).unwrap();
133        assert_eq!(json, "\"P-\u{9f99}\u{867e}-1\"");
134
135        let deserialized: PositionId = serde_json::from_str(&json).unwrap();
136        assert_eq!(deserialized, id);
137    }
138
139    #[rstest]
140    fn test_deserialize_rejects_empty_string() {
141        let result: Result<PositionId, _> = serde_json::from_str(r#""""#);
142        assert!(result.is_err());
143    }
144}
nautilus_model/identifiers/position_id.rs

nautilus_model/identifiers/
position_id.rs
