acton-core 3.0.1

Acton Core provides the core functionality and abstractions used by the Acton Reactive crate. It includes the essential building blocks for creating reactive and distributed systems.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

//! Defines the core traits that establish the fundamental contracts of the Acton framework.
//!
//! This module aggregates the essential traits that define the capabilities and interactions
//! within the Acton agent system. These traits ensure composability and provide a clear
//! interface for messages, agent handles, the message broker, and the subscription mechanism.
//!
//! # Key Traits
//!
//! *   [`ActonMessage`]: A marker trait required for all types used as messages within the system.
//!     Ensures messages are `Send`, `Sync`, `Debug`, `Clone`, and support downcasting via `Any`.
//! *   [`AgentHandleInterface`]: Defines the primary asynchronous interface for interacting with
//!     agents via their handles ([`AgentHandle`](crate::common::AgentHandle)), including sending messages,
//!     managing lifecycle, and accessing metadata.
//! *   [`Broker`]: Defines the interface for broadcasting messages throughout the system,
//!     typically implemented by [`AgentHandle`](crate::common::AgentHandle) which delegates to the
//!     central [`AgentBroker`](crate::common::AgentBroker).
//! *   [`Subscriber`]: Defines the interface for accessing the system's message broker handle.
//! *   [`Subscribable`]: Defines the interface for agents to manage their subscriptions to
//!     message types via the broker.

/*
 * Copyright (c) 2024. Govcraft
 *
 * Licensed under either of
 *   * Apache License, Version 2.0 (the "License");
 *     you may not use this file except in compliance with the License.
 *     You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *   * MIT license: http://opensource.org/licenses/MIT
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the applicable License for the specific language governing permissions and
 * limitations under that License.
 */

// --- Public Re-exports ---
pub use acton_message::ActonMessage;
pub use agent_handle_interface::AgentHandleInterface;
pub use broker::Broker;
pub use subscribable::Subscribable;
pub use subscriber::Subscriber;

// --- Submodules ---

/// Defines the [`ActonMessage`] marker trait.
mod acton_message;
/// Defines the [`AgentHandleInterface`] trait for agent interaction.
mod agent_handle_interface;
/// Defines the [`Broker`] trait for message broadcasting.
mod broker;
/// Defines the [`Subscribable`] trait for managing subscriptions.
mod subscribable;
/// Defines the [`Subscriber`] trait for accessing the broker.
mod subscriber;