nautilus_common/actor/mod.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//! Actor system for event-driven message processing.
17//!
18//! This module provides the actor framework used throughout NautilusTrader for handling
19//! data processing, event management, and asynchronous message handling. Actors are
20//! lightweight components that process messages in isolation.
21
22#![allow(unsafe_code)]
23
24use std::{any::Any, fmt::Debug};
25
26use ustr::Ustr;
27
28#[doc(hidden)]
29pub mod binding;
30pub mod data_actor;
31pub mod indicators;
32pub mod registry;
33
34mod access;
35mod dispatch;
36mod invocation;
37mod storage;
38
39#[cfg(test)]
40pub(crate) mod tests;
41
42// Re-exports
43pub use data_actor::{DataActor, DataActorConfig, DataActorCore, DataActorNative};
44pub(crate) use dispatch::ChainContext;
45
46pub use crate::component::Component;
47
48pub trait Actor: Any + Debug {
49 /// The unique identifier for the actor.
50 fn id(&self) -> Ustr;
51 /// Handles the `msg`.
52 fn handle(&mut self, msg: &dyn Any);
53 /// Returns a reference to `self` as `Any`, for downcasting support.
54 fn as_any(&self) -> &dyn Any;
55 /// Returns a mutable reference to `self` as `Any`, for downcasting support.
56 ///
57 /// Default implementation simply coerces `&mut Self` to `&mut dyn Any`.
58 ///
59 /// # Note
60 ///
61 /// This method is not object-safe and thus only available on sized `Self`.
62 fn as_any_mut(&mut self) -> &mut dyn Any
63 where
64 Self: Sized,
65 {
66 self
67 }
68}