Struct SpawnBuilder 

pub struct SpawnBuilder<'a, Parent, Child, W = NoWatch>
where
    Parent: Actor,
    Child: Actor,
{ /* private fields */ }

Builder for configuring and spawning a child Actor. Created via Ctx::actor.

Implementations

impl<'a, Parent, Child, W> SpawnBuilder<'a, Parent, Child, W>

where Parent: Actor, Child: Actor, W: OnErrTerminate<Child::Err>,

pub fn supervision(self, supervision: Supervision) -> Self

Sets the Supervision strategy the parent will use for this child. Defaults to Supervision::Restart with unlimited restarts and no backoff.

Example

ctx.actor::<Worker>(props)
    .supervision(Supervision::Restart {
        max: Limit::Amount(3),
        backoff: Backoff::Static(Duration::from_secs(1)),
    })
    .spawn();

pub fn watch<F>( self, f: F, ) -> SpawnBuilder<'a, Parent, Child, WatchFn<F, Parent::Msg>>

where F: Fn(&Child::Err) -> Parent::Msg + Send + 'static,

Registers a callback that fires when the child terminates due to an error. This happens when the supervision strategy is Supervision::Stop, or when Supervision::Restart has exhausted all allowed restarts. The callback maps the child’s error into a message for the parent.

Example

ctx.actor::<Worker>(props)
    .supervision(Supervision::Restart {
        max: Limit::Amount(3),
        backoff: Backoff::None,
    })
    .watch(|err| ParentMsg::WorkerDied(format!("{err:?}")))
    .spawn();

pub fn spawn(self) -> Handle<Child::Msg>

Spawns the child Actor and returns a Handle to it.

pub fn spawn_registered(self) -> Result<Handle<Child::Msg>, RegistryError>

Spawns the child and registers it in the global registry under its type name. Other actors can then look it up via Ctx::get_handle_for or Ctx::send. Returns RegistryError::NameTaken if already registered.

pub fn spawn_named( self, name: impl Into<String>, ) -> Result<Handle<Child::Msg>, RegistryError>

Spawns the child and registers it in the global registry under the given name. Other actors can then look it up via Ctx::get_handle or Ctx::send_to. Returns RegistryError::NameTaken if the name is already taken.

Example

let h = ctx.actor::<Worker>(props).spawn_named("worker-1")?;