Struct stakker::Fwd

pub struct Fwd<M: 'static>(_);

Forwarder for messages of type M

Typically this would be created using one of the fwd_*! macros. This may be called many times to forward different messages to the same end-point. For situations where a callback can be used at most one time, prefer Ret, because it is less restrictive on the types of data that may be captured by the closure.

This is a fat pointer to a ref-counted dynamic Fn, so it consumes two usize locally, and the size of the Fn closure plus the ref-count (a usize) on the heap. It may be cloned cheaply if another identical Fwd is required.

For zero arguments, use Fwd<()>. For one argument, use Fwd<type>, where type is the type of the argument. For two or more use a tuple: Fwd<(type1, type2...)>. Call the Fwd::fwd method to send a message or use the fwd! macro. Sending a message typically results in the asynchronous execution of an actor call, but may have other effects depending on the type of forwarder.

Implementations

impl<M> Fwd<M>

pub fn fwd(&self, msg: M)

Forward a message through the Fwd instance

pub fn new(f: impl Fn(M) + 'static) -> Self

Create a Fwd instance that performs an arbitrary action with the message on being called. The call is made synchronously at the point that the message is forwarded.

pub fn to_actor<A: 'static>( actor: Actor<A>, f: impl Fn(&mut A, &mut Cx<'_, A>, M) + Copy + 'static ) -> Self

Create a Fwd instance that queues calls to an actor. The Fn provided must be Copy because on each invocation a new copy is made and put on the queue. Use Ret instead if this is too restrictive.

pub fn to_actor_prep<A: 'static>( actor: Actor<A>, f: impl Fn(&mut Cx<'_, A>, M) -> Option<A> + Copy + 'static ) -> Self

Create a Fwd instance that queues calls to an actor whilst in the Prep phase. Once the actor is Ready, any queued prep calls are dropped.

pub fn panic(msg: impl Into<String>) -> Self

Create a Fwd instance that panics with the given message when called

Trait Implementations

impl<M> Clone for Fwd<M>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.