17 stable releases

1.3.2 Nov 14, 2024
1.3.1 Nov 3, 2024
1.2.10 Jul 8, 2024
1.2.7 Dec 27, 2023
1.1.2 Sep 30, 2023

#480 in Asynchronous

Download history 34/week @ 2024-08-31 2/week @ 2024-09-07 2/week @ 2024-09-14 26/week @ 2024-09-21 32/week @ 2024-09-28 2/week @ 2024-10-05 220/week @ 2024-11-02 110/week @ 2024-11-09 20/week @ 2024-11-16 3/week @ 2024-11-23 10/week @ 2024-11-30

143 downloads per month

MIT license

25KB
565 lines

Actor

Usage

  1. add actor in Cargo.toml
$ cargo add xan-actor
  1. create a actor as mutable
use xan_actor::ActorSystem;
...

let mut actor_system = ActorSystem::new();
  1. declare Actor to register
use crate::xan_actor::{Actor, Handler, Message, ActorError};

#[derive(Clone, Debug)]
pub enum MyMessage {
  A(String),
  B(String),
  Exit,
}

#[derive(thiserror::Error, Debug)]
enum MyError<T, R>
where
  T: Sized + Send + Clone,
  R: Sized + Send,
{
  #[error("bye")]
  Exit,
  #[error(transparent)]
  ActorError(#[from] ActorError<T, R>),
}

struct MyActor {
  pub address: String,
}

#[async_trait::async_trait]
impl Actor<MyMessage, (), MyError<MyMessage, ()>, String> for MyActor
{
  fn address(&self) -> &str {
    &self.address
  }

  async fn actor(
    &mut self, msg: MyMessage,
  ) -> Result<(), MyError<MyMessage, ()>> {
    match msg {
      MyMessage::A(s) => {
        println!("got A: {}", s);
      }
      MyMessage::B(s) => {
        println!("got B: {}", s);
      }
      MyMessage::Exit => {
        println!("got Exit");
        return Err(MyError::Exit);
      }
    }
    Ok(())
  }

  async fn pre_start(&mut self) {}
  async fn pre_restart(&mut self) {}
  async fn post_stop(&mut self) {}
  async fn post_restart(&mut self) {}
}
  1. register actor into actor system
let actor = MyActor {
    address: "some-address".to_string(),
};
actor.register(&mut actor_system).await;
  1. use it
let _ = actor_system.send(
  "some-address".to_string(), /* address */
  MyMessage::A("a".to_string()), /* message */
).await;
let result = actor_system.send_and_recv(
  "some-address".to_string(), /* address */
  MyMessage::B("b".to_string()), /* message */
).await;

// restart actor
actor_system.restart(
  "some-address".to_string(), /* address */
);
// it needs some time. TODO: handle it inside of restart function
tokio::time::sleep(tokio::time::Duration::from_secs(3)).await;

let result = actor_system.send_and_recv(
  "some-address".to_string(), /* address */
  MyMessage::A("a".to_string()), /* message */
).await;

// kill and unregister actor
actor_system.unregister(
  "some-address".to_string(), /* address */
);

Job

  • If you send message at some time or with some iteration, you can use job
use xan_actor::JobSpec;
...

let job = JobSpec::new(
  Some(2), /* max_iter */
  Some(std::time::Duration::from_secs(3)), /* interval */
  std::time::SystemTime::now(), /* start_at */
);
if let Some(recv_rx) = actor_system.run_job(
  "some-address".to_string(), /* address */
  true, /* whether subscribe the handler result or not(true => Some(rx)) */
  job, /* job as JobSpec */
  MyMessage::C("c".to_string()), /* message */
) {
    while let Some(result) = recv_rx.recv().await {
        println!("result returned");
    }
}

Dependencies

~2.6–9MB
~75K SLoC