Handle

Struct Handle 

Source
pub struct Handle<A> { /* private fields */ }
Expand description

A clonable handle to schedule actions onto an actor of type A.

Use Handle::channel to create a (Handle<A>, mpsc::Receiver<Action<A>>) pair, then build your actor with the receiver and spawn its run loop. The handle may be cloned and used concurrently from many tasks/threads.

Implementations§

Source§

impl<A> Handle<A>
where A: Send + 'static,

Source

pub fn channel(capacity: usize) -> (Self, Receiver<Action<A>>)

Create a new actor handle and mailbox receiver with the given capacity.

Returns the (Handle<A>, mpsc::Receiver<Action<A>>) pair. Pass the receiver to your actor and spawn its run loop like this:

let (handle, rx) = Handle::<MyActor>::channel(128);
let actor = MyActor { /* ... */ rx };
tokio::spawn(async move { let _ = actor.run().await; });
Source

pub async fn call<R, F>(&self, f: F) -> Result<R>
where F: for<'a> FnOnce(&'a mut A) -> ActorFut<'a, Result<R>> + Send + 'static, R: Send + 'static,

Schedule an action to run on the actor and await its result.

  • f is a closure that receives &mut A and returns a boxed future yielding anyhow::Result<R>. Use the act! and act_ok! macros to write these concisely.
  • If the actor panics while processing the action, the panic is caught and returned as an anyhow::Error with the call site location.
  • If the actor task has stopped, an error is returned.

Trait Implementations§

Source§

impl<A> Clone for Handle<A>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug> Debug for Handle<A>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<A> Freeze for Handle<A>

§

impl<A> RefUnwindSafe for Handle<A>

§

impl<A> Send for Handle<A>

§

impl<A> Sync for Handle<A>

§

impl<A> Unpin for Handle<A>

§

impl<A> UnwindSafe for Handle<A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.