nautilus-model 0.63.0

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

//! Represents a valid client order ID (assigned by the Nautilus system).

use std::{
    fmt::{Debug, Display},
    hash::Hash,
};

use nautilus_core::correctness::{
    CorrectnessResult, CorrectnessResultExt, FAILED, check_valid_string_ascii,
};
use ustr::Ustr;

const EXTERNAL_CLIENT_ORDER_ID: &str = "EXTERNAL";

/// Represents a valid client order ID (assigned by the Nautilus system).
#[repr(C)]
#[derive(Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
#[cfg_attr(
    feature = "python",
    pyo3::pyclass(module = "nautilus_trader.model", from_py_object)
)]
#[cfg_attr(
    feature = "python",
    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.model")
)]
pub struct ClientOrderId(Ustr);

impl ClientOrderId {
    /// Creates a new [`ClientOrderId`] instance with correctness checking.
    ///
    /// # Errors
    ///
    /// Returns an error if `value` is not a valid string.
    ///
    /// # Notes
    ///
    /// PyO3 requires a `Result` type for proper error handling and stacktrace printing in Python.
    pub fn new_checked<T: AsRef<str>>(value: T) -> CorrectnessResult<Self> {
        let value = value.as_ref();
        check_valid_string_ascii(value, stringify!(value))?;
        Ok(Self(Ustr::from(value)))
    }

    /// Creates a new [`ClientOrderId`] instance.
    ///
    /// # Panics
    ///
    /// Panics if `value` is not a valid string.
    pub fn new<T: AsRef<str>>(value: T) -> Self {
        Self::new_checked(value).expect_display(FAILED)
    }

    /// Sets the inner identifier value.
    #[cfg_attr(not(feature = "python"), allow(dead_code))]
    pub(crate) fn set_inner(&mut self, value: &str) {
        self.0 = Ustr::from(value);
    }

    /// Returns the inner identifier value.
    #[must_use]
    pub fn inner(&self) -> Ustr {
        self.0
    }

    /// Returns the inner identifier value as a string slice.
    #[must_use]
    pub fn as_str(&self) -> &str {
        self.0.as_str()
    }

    /// Creates an external client order ID used when no ID was provided.
    #[must_use]
    pub fn external() -> Self {
        Self::new(EXTERNAL_CLIENT_ORDER_ID)
    }

    /// Returns whether this client order ID is external.
    #[must_use]
    pub fn is_external(&self) -> bool {
        self.0 == EXTERNAL_CLIENT_ORDER_ID
    }
}

impl Debug for ClientOrderId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "\"{}\"", self.0)
    }
}

impl Display for ClientOrderId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

#[must_use]
pub fn optional_ustr_to_vec_client_order_ids(value: Option<Ustr>) -> Option<Vec<ClientOrderId>> {
    value.map(|ids| ids.as_str().split(',').map(ClientOrderId::new).collect())
}

#[must_use]
pub fn optional_vec_client_order_ids_to_ustr(value: Option<Vec<ClientOrderId>>) -> Option<Ustr> {
    value.map(|ids| {
        let value = ids
            .iter()
            .map(ClientOrderId::as_str)
            .collect::<Vec<_>>()
            .join(",");
        Ustr::from(&value)
    })
}

#[cfg(test)]
mod tests {
    use rstest::rstest;
    use ustr::Ustr;

    use super::ClientOrderId;
    use crate::identifiers::{
        client_order_id::{
            optional_ustr_to_vec_client_order_ids, optional_vec_client_order_ids_to_ustr,
        },
        stubs::*,
    };

    #[rstest]
    fn test_string_reprs(client_order_id: ClientOrderId) {
        assert_eq!(client_order_id.as_str(), "O-19700101-000000-001-001-1");
        assert_eq!(format!("{client_order_id}"), "O-19700101-000000-001-001-1");
    }

    #[rstest]
    fn test_external() {
        let external = ClientOrderId::external();
        let local = ClientOrderId::new("LOCAL-1");

        assert_eq!(external.as_str(), "EXTERNAL");
        assert!(external.is_external());
        assert!(!local.is_external());
    }

    #[rstest]
    #[should_panic(expected = "Condition failed: invalid string for 'value', was empty")]
    fn test_new_with_empty_string_panics_with_display_format() {
        let _ = ClientOrderId::new("");
    }

    #[rstest]
    fn test_optional_ustr_to_vec_client_order_ids() {
        assert_eq!(optional_ustr_to_vec_client_order_ids(None), None);
        assert_eq!(
            optional_ustr_to_vec_client_order_ids(Some(Ustr::from("id1,id2,id3"))),
            Some(vec![
                ClientOrderId::new("id1"),
                ClientOrderId::new("id2"),
                ClientOrderId::new("id3"),
            ])
        );
    }

    #[rstest]
    fn test_optional_vec_client_order_ids_to_ustr() {
        assert_eq!(optional_vec_client_order_ids_to_ustr(None), None);
        assert_eq!(
            optional_vec_client_order_ids_to_ustr(Some(vec![
                ClientOrderId::new("id1"),
                ClientOrderId::new("id2"),
                ClientOrderId::new("id3"),
            ])),
            Some(Ustr::from("id1,id2,id3"))
        );
    }
}