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
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101

//! # Hannibal is a rust actors framework based on async-std
//!
//! ## Documentation
//!
//! * [GitHub repository](https://github.com/hoodie/hannibal)
//! * [Cargo package](https://crates.io/crates/hannibal)
//! * Minimum supported Rust version: 1.56 or later
//!
//! ## Features
//!
//! * Async actors.
//! * Actor communication in a local context.
//! * Using Futures for asynchronous message handling.
//! * Typed messages (No `Any` type). Generic messages are allowed.
//!
//! ## Examples
//!
//! ```rust
//! use hannibal::*;
//!
//! #[message(result = "String")]
//! struct ToUppercase(String);
//!
//! struct MyActor;
//!
//! impl Actor for MyActor {}
//!
//! #[async_trait::async_trait]
//! impl Handler<ToUppercase> for MyActor {
//!     async fn handle(&mut self, _ctx: &mut Context<Self>, msg: ToUppercase) -> String {
//!         msg.0.to_uppercase()
//!     }
//! }
//!
//! #[hannibal::main]
//! async fn main() -> Result<()> {
//!     // Start actor and get its address
//!     let mut addr = MyActor.start().await?;
//!
//!     // Send message `ToUppercase` to actor via addr
//!     let res = addr.call(ToUppercase("lowercase".to_string())).await?;
//!     assert_eq!(res, "LOWERCASE");
//!     Ok(())
//! }
//! ```
//!
//! ## References
//!
//! |                                                    |                          |
//! | -------------------------------------------------- | ------------------------ |
//! | [Actix](https://github.com/actix/actix)            | the original inspiration |
//! | [Async-std](https://github.com/async-rs/async-std) | a supported runtime      |
//! | [Tokio](https://tokio.rs/)                         | a supported runtime      |
//! | [Xactor](https://github.com/sunli829/xactor)       | original version of this |

#![allow(clippy::type_complexity)]
#![warn(clippy::doc_markdown)]

mod actor;
mod addr;
mod broker;
mod caller;
mod context;
mod lifecycle;
mod runtime;
mod service;
mod supervisor;

#[cfg(all(feature = "anyhow", feature = "eyre"))]
compile_error!(
    r#"
    features `hannibal/anyhow` and `hannibal/eyre` are mutually exclusive.
    If you are trying to disable anyhow set `default-features = false`.
"#
);

#[cfg(feature = "anyhow")]
pub use anyhow as error;

#[cfg(feature = "eyre")]
pub use eyre as error;

#[cfg_attr(feature = "eyre", doc = "Alias of [`eyre::Result`]")]
#[cfg_attr(not(feature = "eyre"), doc = "Alias of [`anyhow::Result`]")]
pub type Result<T> = error::Result<T>;

#[cfg_attr(feature = "eyre", doc = "Alias of [`eyre::Error`]")]
#[cfg_attr(not(feature = "eyre"), doc = "Alias of [`anyhow::Error`]")]
pub type Error = error::Error;

pub type ActorId = u64;

pub use actor::{Actor, Handler, Message, StreamHandler};
pub use addr::{Addr, WeakAddr};
pub use broker::Broker;
pub use caller::{Caller, Sender};
pub use context::Context;
pub use hannibal_derive::{main, message};
pub use runtime::{block_on, sleep, spawn, timeout};
pub use service::{LocalService, Service};
pub use supervisor::Supervisor;