pub struct Supervisor;Expand description
Supervisor runtime entry point.
Implementations§
Source§impl Supervisor
impl Supervisor
Sourcepub async fn start(
spec: SupervisorSpec,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start( spec: SupervisorSpec, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime from an owned specification value.
§Arguments
spec: Supervisor specification owned by the caller.
§Returns
Returns a SupervisorHandle connected to the runtime control loop.
Sourcepub async fn start_from_config_state(
state: ConfigState,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start_from_config_state( state: ConfigState, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime from validated configuration state.
§Arguments
state: Validated configuration state owned by the caller.
§Returns
Returns a SupervisorHandle only after configuration has produced a
valid supervisor specification.
Sourcepub async fn start_from_config_state_with_factories(
state: ConfigState,
task_factory_registry: TaskFactoryRegistry,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start_from_config_state_with_factories( state: ConfigState, task_factory_registry: TaskFactoryRegistry, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime from validated configuration and a factory registry.
§Arguments
state: Validated configuration state owned by the caller.task_factory_registry: Registry used to bind workerfactory_keyvalues.
§Returns
Returns a SupervisorHandle only after configuration has produced a
valid supervisor specification with executable worker factories.
Sourcepub async fn start_from_config_file(
path: impl AsRef<Path>,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start_from_config_file( path: impl AsRef<Path>, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime from a YAML configuration file.
§Arguments
path: Path to the YAML configuration file.
§Returns
Returns a SupervisorHandle only after the configuration file has
loaded and validated successfully.
Sourcepub async fn start_from_config_file_with_factories(
path: impl AsRef<Path>,
task_factory_registry: TaskFactoryRegistry,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start_from_config_file_with_factories( path: impl AsRef<Path>, task_factory_registry: TaskFactoryRegistry, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime from a YAML file and a factory registry.
§Arguments
path: Path to the YAML configuration file.task_factory_registry: Registry used to bind workerfactory_keyvalues.
§Returns
Returns a SupervisorHandle after configuration and factory binding succeed.
Sourcepub async fn start_with_factory_registry(
spec: SupervisorSpec,
task_factory_registry: TaskFactoryRegistry,
) -> Result<SupervisorHandle, SupervisorError>
pub async fn start_with_factory_registry( spec: SupervisorSpec, task_factory_registry: TaskFactoryRegistry, ) -> Result<SupervisorHandle, SupervisorError>
Starts a supervisor runtime with an explicit task factory registry.
§Arguments
spec: Supervisor specification owned by the caller.task_factory_registry: Registry used by dynamic child declarations.
§Returns
Returns a SupervisorHandle connected to the runtime control loop.
Trait Implementations§
Source§impl Clone for Supervisor
impl Clone for Supervisor
Source§fn clone(&self) -> Supervisor
fn clone(&self) -> Supervisor
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for Supervisor
Source§impl Debug for Supervisor
impl Debug for Supervisor
Source§impl Default for Supervisor
impl Default for Supervisor
Source§fn default() -> Supervisor
fn default() -> Supervisor
Auto Trait Implementations§
impl Freeze for Supervisor
impl RefUnwindSafe for Supervisor
impl Send for Supervisor
impl Sync for Supervisor
impl Unpin for Supervisor
impl UnsafeUnpin for Supervisor
impl UnwindSafe for Supervisor
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>
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);