Struct simple_actor::Actor

pub struct Actor<T: 'static + Send>(_);

Actor wrapping a state.

Implementations

impl<T: 'static + Send> Actor<T>

pub fn new(state: T) -> (Self, impl Future<Output = ()>)

Creates a new Actor with default inbound channel capacity (1024).

Returned future must be spawned in an async executor.

pub fn new_with_capacity(
    state: T,
    capacity: usize
) -> (Self, impl Future<Output = ()>)

Creates a new Actor with given capacity for its inbound channel.

Returned future must be spawned in an async executor.

pub fn invoke<F, R>(&self, invoke: F) -> impl Future<Output = Option<R>> where
    F: FnOnce(&mut T) -> R + 'static + Send,
    R: 'static + Send, 

Interact with the state. Returns None if the actor is no longer running.

pub async fn invoke_future<Fun, Fut, R>(&self, invoke: Fun) -> Option<R> where
    Fun: FnOnce(&mut T) -> Fut + 'static + Send,
    Fut: Future<Output = R> + 'static + Send,
    R: 'static + Send, 

Interact with the state then awaits a Future. This Future cannot hold the reference to the state.

pub fn is_active(&self) -> bool

Tells if the actor still accepts new invokes.

pub fn shutdown(&self)

Stop the actor, which will process every already queued invokes before really stopping.

Trait Implementations

impl<T: Clone + 'static + Send> Clone for Actor<T>

fn clone(&self) -> Actor<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.