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};
44#[doc(hidden)]
45pub use dispatch::DispatchError as CallbackDispatchError;
46pub(crate) use dispatch::{ChainContext, PublicationScope};
47#[cfg(feature = "live")]
48pub(crate) use dispatch::{SendChainContext, collect_command_contexts};
49
50pub use crate::component::Component;
51
52/// Drains at most `budget` callback slots at a caller-established safe boundary.
53///
54/// Returns whether queued slots remain after exhausting the budget. Retained roots alone do not
55/// require another drain. Callers must release component, engine, and cache borrows before entry.
56///
57/// # Errors
58///
59/// Returns the first fatal dispatch error, or an active-work error if delivery cannot safely enter
60/// or encounters an unfinished reservation. A busy head latches a fatal stalled-delivery error.
61/// An otherwise successful drain entered during panic unwinding latches a fatal error on exit;
62/// its result remains successful, and [`callback_failure`] reports the failure.
63#[doc(hidden)]
64pub fn drain_callbacks(budget: usize) -> Result<bool, CallbackDispatchError> {
65    let result = dispatch::drain_at_boundary(budget)?;
66    Ok(result.status == dispatch::DrainStatus::BudgetExhausted)
67}
68
69/// Returns the first fatal callback dispatch error on this thread.
70#[doc(hidden)]
71#[must_use]
72pub fn callback_failure() -> Option<CallbackDispatchError> {
73    dispatch::failure()
74}
75
76/// Releases queued callback captures and resets dispatch accounting at a safe boundary.
77/// Clearing also resets the latched fatal failure.
78///
79/// # Errors
80///
81/// Returns an active-work error while access, reservations, or externally retained roots remain.
82/// Callers must release queued commands and other retained work before clearing callbacks.
83#[doc(hidden)]
84pub fn clear_callbacks() -> Result<(), CallbackDispatchError> {
85    dispatch::clear()
86}
87
88pub trait Actor: Any + Debug {
89    /// The unique identifier for the actor.
90    fn id(&self) -> Ustr;
91    /// Handles the `msg`.
92    fn handle(&mut self, msg: &dyn Any);
93    /// Returns a reference to `self` as `Any`, for downcasting support.
94    fn as_any(&self) -> &dyn Any;
95    /// Returns a mutable reference to `self` as `Any`, for downcasting support.
96    ///
97    /// Default implementation simply coerces `&mut Self` to `&mut dyn Any`.
98    ///
99    /// # Note
100    ///
101    /// This method is not object-safe and thus only available on sized `Self`.
102    fn as_any_mut(&mut self) -> &mut dyn Any
103    where
104        Self: Sized,
105    {
106        self
107    }
108}
nautilus_common/actor/mod.rs

nautilus_common/actor/
mod.rs
