pub struct SubsystemManager { /* private fields */ }
Expand description
Manager for coordinating multiple subsystems.
Implementations§
Source§impl SubsystemManager
impl SubsystemManager
Sourcepub fn new(shutdown_coordinator: ShutdownCoordinator) -> Self
pub fn new(shutdown_coordinator: ShutdownCoordinator) -> Self
Create a new subsystem manager.
Sourcepub fn enable_events(&self)
pub fn enable_events(&self)
Enable coordination events. Subsequent state changes will emit SubsystemEvent
s.
§Panics
Panics if the internal mutex is poisoned.
Sourcepub fn try_next_event(&self) -> Option<SubsystemEvent>
pub fn try_next_event(&self) -> Option<SubsystemEvent>
Try to fetch the next coordination event without blocking.
§Panics
Panics if the internal mutex is poisoned.
Sourcepub fn register<S: Subsystem>(&self, subsystem: S) -> SubsystemId
pub fn register<S: Subsystem>(&self, subsystem: S) -> SubsystemId
Register a new subsystem with the manager.
Returns a unique ID for the registered subsystem.
§Panics
Panics if the internal mutex is poisoned.
Sourcepub fn register_fn<F, Fut>(&self, name: &str, func: F) -> SubsystemId
pub fn register_fn<F, Fut>(&self, name: &str, func: F) -> SubsystemId
Sourcepub fn register_closure<F>(
&self,
closure_subsystem: F,
name: &str,
) -> SubsystemId
pub fn register_closure<F>( &self, closure_subsystem: F, name: &str, ) -> SubsystemId
Sourcepub async fn start_subsystem(&self, id: SubsystemId) -> Result<()>
pub async fn start_subsystem(&self, id: SubsystemId) -> Result<()>
Sourcepub async fn stop_subsystem(&self, id: SubsystemId) -> Result<()>
pub async fn stop_subsystem(&self, id: SubsystemId) -> Result<()>
Sourcepub async fn restart_subsystem(&self, id: SubsystemId) -> Result<()>
pub async fn restart_subsystem(&self, id: SubsystemId) -> Result<()>
Sourcepub fn get_stats(&self) -> SubsystemStats
pub fn get_stats(&self) -> SubsystemStats
Sourcepub fn get_subsystem_metadata(
&self,
id: SubsystemId,
) -> Option<SubsystemMetadata>
pub fn get_subsystem_metadata( &self, id: SubsystemId, ) -> Option<SubsystemMetadata>
Get metadata for a specific subsystem.
§Panics
Panics if the subsystem mutex is poisoned.
Returns None
if the subsystem with the specified ID is not found.
Sourcepub fn get_all_metadata(&self) -> Vec<SubsystemMetadata>
pub fn get_all_metadata(&self) -> Vec<SubsystemMetadata>
Sourcepub fn run_health_checks(&self) -> Vec<(SubsystemId, String, bool)>
pub fn run_health_checks(&self) -> Vec<(SubsystemId, String, bool)>
Run health checks on all subsystems and return the results.
§Panics
Panics if the subsystem mutex is poisoned.
Source§impl SubsystemManager
impl SubsystemManager
Sourcepub fn subscribe_events(&self) -> Option<Receiver<SubsystemEvent>>
pub fn subscribe_events(&self) -> Option<Receiver<SubsystemEvent>>
Subscribe to subsystem coordination events (lock-free backend only).
Returns a cloned receiver to the shared event stream when the
lockfree-coordination
feature is enabled and events have been
previously enabled via enable_events()
.
§Panics
Panics if the internal mutex is poisoned.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for SubsystemManager
impl !RefUnwindSafe for SubsystemManager
impl Send for SubsystemManager
impl Sync for SubsystemManager
impl Unpin for SubsystemManager
impl !UnwindSafe for SubsystemManager
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
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>
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);