nautilus_common/actor/mod.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//! Actor system for event-driven message processing.
17//!
18//! This module provides the actor framework used throughout PoseiTrader 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
28pub mod data_actor;
29#[cfg(feature = "indicators")]
30pub(crate) mod indicators;
31pub mod registry;
32
33#[cfg(test)]
34mod tests;
35
36// Re-exports
37pub use data_actor::{DataActor, DataActorCore};
38
39pub use crate::component::Component;
40
41pub trait Actor: Any + Debug {
42 /// The unique identifier for the actor.
43 fn id(&self) -> Ustr;
44 /// Handles the `msg`.
45 fn handle(&mut self, msg: &dyn Any);
46 /// Returns a reference to `self` as `Any`, for downcasting support.
47 fn as_any(&self) -> &dyn Any;
48 /// Returns a mutable reference to `self` as `Any`, for downcasting support.
49 ///
50 /// Default implementation simply coerces `&mut Self` to `&mut dyn Any`.
51 ///
52 /// # Note
53 ///
54 /// This method is not object-safe and thus only available on sized `Self`.
55 fn as_any_mut(&mut self) -> &mut dyn Any
56 where
57 Self: Sized,
58 {
59 self
60 }
61}