Skip to main content

Context

Struct Context 

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

Actor execution context providing communication and spawning capabilities.

The Context is passed to actor methods and provides access to:

  • Self reference for sending messages to itself via ctx.this.upgrade()
  • Child actor management via ctx.spawn()
  • Actor metadata via ctx.id()
  • Lifecycle control via ctx.terminate()

§Type Parameters

  • A - The actor type this context belongs to

Fields§

§this: WeakActorRef<A>

Weak reference to this actor instance

Implementations§

Source§

impl<A: Actor> Context<A>

Source

pub fn id(&self) -> ActorId

Get the unique identifier of this actor.

§Return

ActorId uniquely identifying this actor instance.

Source

pub fn spawn<Args: ActorArgs>(&self, args: Args) -> ActorRef<Args::Actor>

Spawn a new child actor with the given arguments.

§Arguments
  • args - Initialization arguments for the new actor
§Return

ActorRef<Args::Actor> reference to the newly spawned actor.

§Panics

Panics if the internal child handle lock is poisoned.

Source

pub async fn terminate(&self)

Terminate this actor and all its children.

§Panics

Panics if the signal channel is unexpectedly closed.

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 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + 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> PersistentContextExt<A> for Context<A>

Source§

fn save_snapshot<S: PersistentStorage>( &self, storage: &S, state: &A, ) -> impl Future<Output = Result<()>> + Send

Save a snapshot of the actor’s current state to storage. Read more
Source§

impl<A> PersistentSpawnExt for Context<A>
where A: Actor,

Source§

async fn spawn_persistent<S, Args>( &self, _storage: &S, actor_id: ActorId, args: Args, ) -> Result<ActorRef<Args::Actor>, PersistenceError>

Spawn an actor with persistence support. Read more
Source§

async fn respawn<S, B>( &self, storage: &S, actor_id: ActorId, runtime_args: B::RuntimeArgs, ) -> Result<ActorRef<B>, PersistenceError>

Since it coerce the given Id to actor, it is callers’ responsibility to ensure no more than one actor is spawned with the same ID.Failure to do so will not result error immediately, but latened undefined behavior.It does not invoke PersistentContextExt::save_snapshot automatically, it should be specified in ActorArgs::initialize if needed. Read more
Source§

async fn respawn_or<S, Args>( &self, storage: &S, actor_id: ActorId, runtime_args: impl FnOnce() -> <<Args as ActorArgs>::Actor as PersistentActor>::RuntimeArgs + Send, default_args: impl FnOnce() -> Args + Send, ) -> Result<ActorRef<Args::Actor>, PersistenceError>

Since it coerce the given Id to actor, it is callers’ responsibility to ensure no more than one actor is spawned with the same ID.Failure to do so will not result error immediately, but latened undefined behavior.It does not invoke PersistentContextExt::save_snapshot automatically, it should be specified in ActorArgs::initialize if needed. Read more

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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