Skip to main content

Context

Struct Context 

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

Passed to every Actor::handle call.

Implementations§

Source§

impl<A: Actor> Context<A>

Source

pub fn phase(&self) -> LifecyclePhase

Current lifecycle phase. Phase 1.C marker — useful in generic helpers that need to gate calls (e.g. become, unstash_all) without taking a typed-Context<A, P> parameter.

Source

pub fn self_ref(&self) -> &ActorRef<A::Msg>

Source

pub fn path(&self) -> &ActorPath

Source

pub fn spawn<B: Actor>( &mut self, props: Props<B>, name: &str, ) -> Result<ActorRef<B::Msg>, SpawnError>

Spawn a child actor under this context.

Source

pub fn stop_child(&mut self, name: &str)

Stop a specific child.

Source

pub fn watch<M: Send + 'static>(&mut self, target: &ActorRef<M>)

Watch another actor. The sender is notified with a SystemMsg::Terminated when the watched actor stops.

Source

pub fn unwatch<M: Send + 'static>(&mut self, target: &ActorRef<M>)

Stop watching.

Source

pub fn stash(&mut self, msg: A::Msg)

Stash the currently-processed message for later unstash.

Source

pub fn unstash_all(&mut self) -> Vec<A::Msg>

Put all stashed messages back at the front of the mailbox.

Source

pub fn stop_self(&mut self)

Stop self.

Source

pub fn set_receive_timeout(&mut self, d: Option<Duration>)

Set idle-receive timeout (like).

Source

pub fn sender(&self) -> &Sender

Typed sender of the message currently being processed.

Returns Sender::None if the sender slot was empty (the analog of Sender == NoSender).

Source

pub fn phased<P: PhaseMarker>(&mut self) -> Option<TypedContext<'_, A, P>>

Borrow this context as a phase-typed view. The phase parameter is a phantom witness only — call sites typically use one of Context::starting, Context::running, or Context::stopping to get a view whose method surface matches the phase.

Source

pub fn starting(&mut self) -> Option<TypedContext<'_, A, Starting>>

Phase-typed view valid only while the actor is in Starting.

Source

pub fn running(&mut self) -> Option<TypedContext<'_, A, Running>>

Phase-typed view valid only while the actor is in Running.

Source

pub fn stopping_view(&mut self) -> Option<TypedContext<'_, A, Stopping>>

Phase-typed view valid only while the actor is in Stopping.

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>
where <A as Actor>::Msg: Sync,

§

impl<A> Unpin for Context<A>
where <A as Actor>::Msg: Unpin,

§

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> 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, 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
Source§

impl<T> Extension for T
where T: Any + Send + Sync,