nautilus_execution/models/
latency.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Posei Systems Pty Ltd. All rights reserved.
3//  https://poseitrader.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
16use std::fmt::Display;
17
18use nautilus_core::UnixNanos;
19
20/// Provides latency modeling for order processing operations.
21///
22/// Models the latency for different order operations including base network latency
23/// and specific operation latencies for insert, update, and delete operations.
24#[derive(Debug)]
25pub struct LatencyModel {
26    pub base_latency_nanos: UnixNanos,
27    pub insert_latency_nanos: UnixNanos,
28    pub update_latency_nanos: UnixNanos,
29    pub delete_latency_nanos: UnixNanos,
30}
31
32impl LatencyModel {
33    /// Creates a new [`LatencyModel`] instance.
34    #[must_use]
35    pub const fn new(
36        base_latency_nanos: UnixNanos,
37        insert_latency_nanos: UnixNanos,
38        update_latency_nanos: UnixNanos,
39        delete_latency_nanos: UnixNanos,
40    ) -> Self {
41        Self {
42            base_latency_nanos,
43            insert_latency_nanos,
44            update_latency_nanos,
45            delete_latency_nanos,
46        }
47    }
48}
49
50impl Display for LatencyModel {
51    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
52        write!(f, "LatencyModel()")
53    }
54}