Skip to main content

Supervisor

Struct Supervisor 

Source
pub struct Supervisor { /* private fields */ }
Expand description

A supervisor that manages child actors.

Implementations§

Source§

impl Supervisor

Source

pub fn new(strategy: SupervisionStrategy) -> Self

Create a new supervisor with the given strategy.

Source

pub fn with_parent(strategy: SupervisionStrategy, parent: ActorId) -> Self

Create a new supervisor with a parent.

Source

pub fn id(&self) -> ActorId

Get the supervisor’s ID.

Source

pub fn parent(&self) -> Option<ActorId>

Get the parent supervisor ID.

Source

pub fn set_escalation_action(&mut self, action: EscalationAction)

Set the escalation action.

Source

pub fn start_child(&mut self, spec: ChildSpec) -> Result<ActorId>

Start a new child actor.

Source

pub fn stop_child(&mut self, name: &str) -> Result<()>

Stop a child actor gracefully.

Source

pub fn terminate_child(&mut self, name: &str, reason: ExitReason) -> Result<()>

Terminate a child actor with a specific reason.

Source

pub fn which_children(&self) -> Vec<&SupervisedChild>

Get a list of all children.

Source

pub fn count_children(&self) -> SupervisorStats

Get statistics about the supervisor.

Source

pub async fn handle_child_exit( &mut self, name: &str, reason: ExitReason, ) -> Result<()>

Handle a child exit event.

Source

pub fn remove_child(&mut self, name: &str) -> Result<SupervisedChild>

Remove a child from supervision.

Source

pub fn get_child(&self, name: &str) -> Option<&SupervisedChild>

Get a child by name.

Source

pub fn get_child_mut(&mut self, name: &str) -> Option<&mut SupervisedChild>

Get a child by name mutably.

Source

pub fn has_child(&self, name: &str) -> bool

Check if a child exists.

Source

pub fn child_count(&self) -> usize

Get the number of children.

Source

pub fn mark_child_running(&mut self, name: &str) -> Result<()>

Mark a restarting child as running.

Trait Implementations§

Source§

impl Debug for Supervisor

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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