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 an error if a fatal dispatch failure has been recorded, delivery cannot safely enter, or
60/// delivery encounters an unfinished reservation. Returns the first fatal dispatch error, or an
61/// active-work error for unsafe entry or unfinished reservations. A busy head latches a fatal
62/// stalled-delivery error. An otherwise successful drain entered during panic unwinding latches a
63/// fatal error on exit; its result remains successful, and [`callback_failure`] reports the
64/// failure.
65#[doc(hidden)]
66pub fn drain_callbacks(budget: usize) -> Result<bool, CallbackDispatchError> {
67    let result = dispatch::drain_at_boundary(budget)?;
68    Ok(result.status == dispatch::DrainStatus::BudgetExhausted)
69}
70
71/// Returns the first fatal callback dispatch error on this thread.
72#[doc(hidden)]
73#[must_use]
74pub fn callback_failure() -> Option<CallbackDispatchError> {
75    dispatch::failure()
76}
77
78/// Releases queued callback captures and resets dispatch accounting at a safe boundary.
79/// Clearing also resets the latched fatal failure.
80///
81/// # Errors
82///
83/// Returns an error if access, reservations, or externally retained roots remain. The error reports
84/// active work. Callers must release queued commands and other retained work before clearing
85/// callbacks.
86#[doc(hidden)]
87pub fn clear_callbacks() -> Result<(), CallbackDispatchError> {
88    dispatch::clear()
89}
90
91pub trait Actor: Any + Debug {
92    /// The unique identifier for the actor.
93    fn id(&self) -> Ustr;
94    /// Handles the `msg`.
95    fn handle(&mut self, msg: &dyn Any);
96    /// Returns a reference to `self` as `Any`, for downcasting support.
97    fn as_any(&self) -> &dyn Any;
98    /// Returns a mutable reference to `self` as `Any`, for downcasting support.
99    ///
100    /// Default implementation simply coerces `&mut Self` to `&mut dyn Any`.
101    ///
102    /// # Note
103    ///
104    /// This method is not object-safe and thus only available on sized `Self`.
105    fn as_any_mut(&mut self) -> &mut dyn Any
106    where
107        Self: Sized,
108    {
109        self
110    }
111}
nautilus_common/actor/mod.rs

nautilus_common/actor/
mod.rs
