Skip to main content

Context

Struct Context 

Source
pub struct Context<A: Actor> { /* private fields */ }
Expand description

Handle passed to every handler and lifecycle hook, providing access to the actor’s mailbox and lifecycle controls.

Clone is cheap — it clones the inner channel sender and cancellation token.

Implementations§

Source§

impl<A: Actor> Context<A>

Source

pub fn from_ref(actor_ref: &ActorRef<A>) -> Self

Create a Context from an ActorRef. Useful for setting up timers or stream listeners from outside the actor.

Source

pub fn stop(&self)

Signal the actor to stop. The current handler will finish, then stopped() is called and the actor exits.

Source

pub fn send<M>(&self, msg: M) -> Result<(), ActorError>
where A: Handler<M>, M: Message,

Send a fire-and-forget message to this actor.

Source

pub fn request_raw<M>(&self, msg: M) -> Result<Receiver<M::Result>, ActorError>
where A: Handler<M>, M: Message,

Send a request and get a raw oneshot receiver for the reply.

Source

pub async fn request<M>(&self, msg: M) -> Result<M::Result, ActorError>
where A: Handler<M>, M: Message,

Send a request and wait for the reply (default 5s timeout).

Source

pub async fn request_with_timeout<M>( &self, msg: M, duration: Duration, ) -> Result<M::Result, ActorError>
where A: Handler<M>, M: Message,

Send a request and wait for the reply with a custom timeout.

Source

pub fn recipient<M>(&self) -> Recipient<M>
where A: Handler<M>, M: Message,

Get a type-erased Recipient<M> for sending a single message type to this actor.

Source

pub fn actor_ref(&self) -> ActorRef<A>

Get an ActorRef<A> from this context.

Trait Implementations§

Source§

impl<A: Actor> Clone for Context<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: Actor> Debug for Context<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A, M> Receiver<M> for Context<A>
where A: Actor + Handler<M>, M: Message,

Source§

fn send(&self, msg: M) -> Result<(), ActorError>

Source§

fn request_raw(&self, msg: M) -> Result<Receiver<M::Result>, ActorError>

Auto Trait Implementations§

§

impl<A> Freeze for Context<A>

§

impl<A> !RefUnwindSafe for Context<A>

§

impl<A> Send for Context<A>

§

impl<A> Sync for Context<A>

§

impl<A> Unpin for Context<A>

§

impl<A> UnsafeUnpin for Context<A>

§

impl<A> !UnwindSafe for Context<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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more