nautilus_common/signal.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
16//! A user signal type.
17
18use nautilus_core::UnixNanos;
19use serde::{Deserialize, Serialize};
20use ustr::Ustr;
21
22/// Represents a generic signal.
23#[repr(C)]
24#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
25#[cfg_attr(
26 feature = "python",
27 pyo3::pyclass(module = "posei_trader.core.nautilus_pyo3.common")
28)]
29pub struct Signal {
30 pub name: Ustr,
31 pub value: String,
32 pub ts_event: UnixNanos,
33 pub ts_init: UnixNanos,
34}
35
36impl Signal {
37 /// Creates a new [`Signal`] instance.
38 #[must_use]
39 pub const fn new(name: Ustr, value: String, ts_event: UnixNanos, ts_init: UnixNanos) -> Self {
40 Self {
41 name,
42 value,
43 ts_event,
44 ts_init,
45 }
46 }
47}