Skip to main content

ChildSpec

Struct ChildSpec 

Source
pub struct ChildSpec<R: Reactor> {
    pub name: String,
    pub restart: RestartPolicy,
    pub shutdown: ShutdownPolicy,
    pub namespace: NamespacePolicy,
    pub mailbox_capacity: usize,
    pub factory: Arc<dyn Fn() -> Box<dyn Actor<R>> + Send + Sync>,
    pub stable_addr_refresher: Option<Arc<dyn AddrRefresher>>,
}
Expand description

Specification provided at spawn time that governs a child actor’s lifecycle.

factory is called by the supervisor whenever it needs to (re)create the child actor — at initial spawn and after each restart. It must be Send + Sync so the supervisor task can share the spec across threads.

Fields§

§name: String§restart: RestartPolicy§shutdown: ShutdownPolicy§namespace: NamespacePolicy§mailbox_capacity: usize§factory: Arc<dyn Fn() -> Box<dyn Actor<R>> + Send + Sync>

Factory function that produces a fresh Box<dyn Actor<R>> on each (re)spawn. The closure must be cheap to call repeatedly.

§stable_addr_refresher: Option<Arc<dyn AddrRefresher>>

Optional refresher notified by the supervisor after each (re)spawn. Set via ChildSpec::with_stable_addr.

Implementations§

Source§

impl<R: Reactor> ChildSpec<R>

Source

pub fn new( name: impl Into<String>, restart: RestartPolicy, shutdown: ShutdownPolicy, namespace: NamespacePolicy, factory: impl Fn() -> Box<dyn Actor<R>> + Send + Sync + 'static, ) -> Self

Source

pub fn with_mailbox_capacity(self, capacity: usize) -> Self

Builder-style method to override the default mailbox capacity.

Source

pub fn with_stable_addr(self, refresher: Arc<dyn AddrRefresher>) -> Self

Attach an AddrRefresher so the supervisor updates a [StableAddr] after each spawn of this child.

Trait Implementations§

Source§

impl<R: Clone + Reactor> Clone for ChildSpec<R>

Source§

fn clone(&self) -> ChildSpec<R>

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<R: Reactor> Debug for ChildSpec<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for ChildSpec<R>

§

impl<R> !RefUnwindSafe for ChildSpec<R>

§

impl<R> Send for ChildSpec<R>

§

impl<R> Sync for ChildSpec<R>

§

impl<R> Unpin for ChildSpec<R>

§

impl<R> UnsafeUnpin for ChildSpec<R>

§

impl<R> !UnwindSafe for ChildSpec<R>

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, 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.