Struct xtra::SendFuture

pub struct SendFuture<F, S> { /* private fields */ }

A Future that represents the state of sending a message to an actor.

By default, a SendFuture will resolve to the return value of the handler (see Handler::Return). This behaviour can be changed by calling detach.

A detached SendFuture will resolve once the message is successfully queued into the actor’s mailbox and resolve to the Receiver. The Receiver itself is a future that will resolve to the return value of the Handler.

In other words, detaching a SendFuture allows the current task to continue while the corresponding Handler of the actor processes the message.

In case an actor’s mailbox is bounded, SendFuture will yield Pending until the message is queued successfully. This allows an actor to exercise backpressure on its users.

Implementations

impl<F, R> SendFuture<F, ResolveToHandlerReturn<R>>

where F: Future,

pub fn detach(self) -> SendFuture<F, ResolveToReceiver<R>>

Detaches this future from receiving the response of the handler.

Awaiting a detached SendFuture will queue the message in the actor’s mailbox and return you another Future for receiving the response.

impl<F, S> SendFuture<F, S>

where F: SetPriority,

pub fn priority(self, new_priority: u32) -> Self

Set the priority of a given message. See Address documentation for more info.

Panics if this future has already been polled.

Trait Implementations

impl<F> Future for SendFuture<F, Broadcast>

where F: Future<Output = Result<(), Error>> + Unpin,

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<R, F> Future for SendFuture<F, ResolveToHandlerReturn<R>>

where F: Future<Output = Result<(), Error>> + FusedFuture + Unpin,

type Output = Result<R, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<R, F> Future for SendFuture<F, ResolveToReceiver<R>>

where F: Future<Output = Result<(), Error>> + FusedFuture + Unpin,

type Output = Result<Receiver<R>, Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &mut Context<'_>) -> Poll<Self::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.