ractor_supervisor::supervisor

Struct SupervisorState

Source
pub struct SupervisorState {
    pub child_specs: Vec<ChildSpec>,
    pub running: HashMap<String, ActorCell>,
    pub child_failure_state: HashMap<String, ChildFailureState>,
    pub restart_log: Vec<RestartLog>,
    pub options: SupervisorOptions,
}
Expand description

Holds the supervisor’s live state: which children are running, how many times each child has failed, etc.

Fields§

§child_specs: Vec<ChildSpec>

The original child specs (each child’s config).

§running: HashMap<String, ActorCell>

The currently running children: child_id -> ActorCell.

§child_failure_state: HashMap<String, ChildFailureState>

Tracks how many times each child has failed and the last time it failed.

§restart_log: Vec<RestartLog>

Rolling log of all restarts in the meltdown window.

§options: SupervisorOptions

Supervisor meltdown options.

Implementations§

Source§

impl SupervisorState

Source

pub async fn spawn_all_children( &mut self, supervisor_cell: ActorCell, ) -> Result<(), ActorProcessingErr>

Spawn all children in the order they were defined in SupervisorArguments::child_specs.

Source

pub fn prepare_child_failure( &mut self, child_id: &str, ) -> Result<(), ActorProcessingErr>

Increments the failure count for a given child.
Resets the child’s restart_count to 0 if the time since last fail >= child’s restart_counter_reset_after.

Source

pub fn get_child_id_by_cell_id(&self, cell_id: ActorId) -> Option<String>

Return the child ID for a given ActorCell, if it’s in the running map.

Source

pub fn handle_child_exit( &mut self, child_id: &str, abnormal: bool, ) -> Result<Option<String>, ActorProcessingErr>

Called when a child terminates or fails.

  • If abnormal == true, we treat it like a panic or error exit.
  • We remove the child from running.
  • If the child’s Restart policy indicates a restart is needed, we do it.

Returns Some(child_id) if the supervisor should re-spawn the child, or None otherwise.

Source

pub fn schedule_restart( &mut self, child_id: &String, strategy: Strategy, myself: ActorRef<SupervisorMsg>, ) -> Result<(), ActorProcessingErr>

Schedule a future spawn for a child, respecting any child-level backoff_fn.

Source

pub async fn perform_one_for_one_spawn( &mut self, child_id: &str, supervisor_cell: ActorCell, ) -> Result<(), ActorProcessingErr>

OneForOne: meltdown-check first, then spawn just the failing child.

Source

pub async fn perform_one_for_all_spawn( &mut self, child_id: &str, myself: ActorRef<SupervisorMsg>, supervisor_cell: ActorCell, ) -> Result<(), ActorProcessingErr>

OneForAll: meltdown-check first, then stop all children, re-spawn them all.

Source

pub async fn perform_rest_for_one_spawn( &mut self, child_id: &str, myself: ActorRef<SupervisorMsg>, supervisor_cell: ActorCell, ) -> Result<(), ActorProcessingErr>

RestForOne: meltdown-check first, then stop the failing child and all subsequent children, re-spawn them.

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> Message for T
where T: Any + Send + 'static,

Source§

fn from_boxed(m: BoxedMessage) -> Result<Self, BoxedDowncastErr>

Convert a BoxedMessage to this concrete type
Source§

fn box_message(self, pid: &ActorId) -> Result<BoxedMessage, BoxedDowncastErr>

Convert this message to a BoxedMessage
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> State for T
where T: Any + Send + 'static,