Struct WithRecipient 

pub struct WithRecipient<Req, Resp>
where
    Req: MessageBounds,
    Resp: Debug + 'static,
{ /* private fields */ }

A generic type for request-response messages with a Recipient as actor reference

This type contains narrowed information about the target actor for the response, as well as the actual request itself.

Implementations can also be dereferenced to the request message and replied to with a response.

Implementations

impl<Req, Resp> WithRecipient<Req, Resp>

where Req: MessageBounds, Resp: Debug + 'static,

pub fn new(content: Req, sender: Recipient<Resp>) -> WithRecipient<Req, Resp>

Create a new instance from a request and a recipient for the response

pub fn from<M>( content: Req, sender: &dyn ActorRefFactory<Message = M>, ) -> WithRecipient<Req, Resp>

where M: MessageBounds + From<Resp>,

Create a new instance from a request and something that can produce a reference to an actor to reply to

This variant is convenient from within a component, as components and their contexts implement ActorRefFactory for their actor message type.

pub fn from_convert<M>( content: Req, sender: &dyn ActorRefFactory<Message = M>, convert: fn(Resp) -> M, ) -> WithRecipient<Req, Resp>

where M: MessageBounds,

Create a new instance from a request and something that can produce a reference to an actor to reply to, with custom convert function

This variant is convenient from within a component, as components and their contexts implement ActorRefFactory for their actor message type.

pub fn sender(&self) -> &Recipient<Resp>

Returns a strong reference to the response target actor

pub fn content(&self) -> &Req

Returns a reference to the content

pub fn take_content(self) -> Req

Takes only the content

This prevents the request from being completed, as the sender is dropped! Use only after replying to the request.

Trait Implementations

impl<Req, Resp> Debug for WithRecipient<Req, Resp>

where Req: Debug + MessageBounds, Resp: Debug + 'static,

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

Formats the value using the given formatter.

impl<Req, Resp> Deref for WithRecipient<Req, Resp>

where Req: MessageBounds, Resp: Debug + 'static,

type Target = Req

The resulting type after dereferencing.

fn deref(&self) -> &<WithRecipient<Req, Resp> as Deref>::Target

Dereferences the value.

impl<Req, Resp> Request for WithRecipient<Req, Resp>

where Req: MessageBounds, Resp: Debug + 'static,

type Response = Resp

The type of the response that is expected

fn reply(&self, resp: <WithRecipient<Req, Resp> as Request>::Response)

Fulfill this request by supplying a response of the appropriate type