pub struct RuntimeControlState {
pub orphan_count: u64,
/* private fields */
}Expand description
Mutable state owned by the control loop.
Fields§
§orphan_count: u64Active count of orphaned child tasks that could not be stopped within policy timeouts.
Implementations§
Source§impl RuntimeControlState
impl RuntimeControlState
Sourcepub fn new(
spec: SupervisorSpec,
command_sender: Sender<RuntimeLoopMessage>,
observability: Arc<Mutex<ObservabilityPipeline>>,
) -> Result<Self, SupervisorError>
pub fn new( spec: SupervisorSpec, command_sender: Sender<RuntimeLoopMessage>, observability: Arc<Mutex<ObservabilityPipeline>>, ) -> Result<Self, SupervisorError>
Creates control state from a supervisor specification.
§Arguments
spec: Supervisor declaration that owns children and strategy.command_sender: Sender used by child start_counts to report exits.
§Returns
Returns a RuntimeControlState value.
Sourcepub fn new_with_factory_registry(
spec: SupervisorSpec,
command_sender: Sender<RuntimeLoopMessage>,
observability: Arc<Mutex<ObservabilityPipeline>>,
task_factory_registry: TaskFactoryRegistry,
) -> Result<Self, SupervisorError>
pub fn new_with_factory_registry( spec: SupervisorSpec, command_sender: Sender<RuntimeLoopMessage>, observability: Arc<Mutex<ObservabilityPipeline>>, task_factory_registry: TaskFactoryRegistry, ) -> Result<Self, SupervisorError>
Creates control state with a task factory registry for dynamic children.
§Arguments
spec: Supervisor declaration that owns children and strategy.command_sender: Sender used by child start_counts to report exits.observability: Shared observability pipeline.task_factory_registry: Registry used byadd_childdeclarations.
§Returns
Returns a RuntimeControlState value.
Sourcepub async fn start_declared_children(&mut self)
pub async fn start_declared_children(&mut self)
Starts every declared child in supervisor startup order.
Children are spawned in topological order (dependencies first), but
readiness waiting (a child’s dependencies must be ready before it
starts) is not yet implemented — this is tracked for a future slice.
As a result, children that declare dependencies will start in the
correct order but dependencies must report ready before the
dependent child starts. This prevents downstream workers from
beginning execution before their required services (database,
cache, message queue) are ready to serve requests.
§Arguments
This function has no arguments.
§Returns
This function does not return a value.
Sourcepub fn set_exit_handler(&mut self, handler: Arc<dyn ExitHandler>)
pub fn set_exit_handler(&mut self, handler: Arc<dyn ExitHandler>)
Records an active attempt after spawn_once so exit routing matches registry identities.
Immediate spawns run this inline; delayed backoff spawns deliver the same handle through
ChildStartMessage::DelayedSpawnAttached so activate_instance stays on the control loop.
§Arguments
child_id: Stable child owning the spawned attempt.path: Supervisor path used when inserting placeholder runtime records.generation: Generation pinned from the registryChildRuntimepassed tospawn_once.attempt: Attempt counter pinned from the same registry record.handle: Runner handle carrying cancellation and completion endpoints.
§Returns
Sets the exit handler strategy for process termination.
The default handler calls std::process::exit(1). Tests can swap in
a stub that records the exit request without terminating the process.
§Arguments
handler: Exit handler implementation.
§Returns
This function does not return a value.
Sourcepub async fn execute_control(
&mut self,
command: ControlCommand,
event_sender: &Sender<String>,
) -> Result<CommandResult, SupervisorError>
pub async fn execute_control( &mut self, command: ControlCommand, event_sender: &Sender<String>, ) -> Result<CommandResult, SupervisorError>
Sourcepub fn handle_child_exit(
&mut self,
report: ChildRunReport,
event_sender: &Sender<String>,
)
pub fn handle_child_exit( &mut self, report: ChildRunReport, event_sender: &Sender<String>, )
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for RuntimeControlState
impl !RefUnwindSafe for RuntimeControlState
impl !UnwindSafe for RuntimeControlState
impl Send for RuntimeControlState
impl Sync for RuntimeControlState
impl Unpin for RuntimeControlState
impl UnsafeUnpin for RuntimeControlState
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);