pub struct TaskContext {
pub child_id: ChildId,
pub path: SupervisorPath,
pub generation: Generation,
pub child_start_count: ChildStartCount,
/* private fields */
}Expand description
Context passed to a task for a single child_start_count.
Fields§
§child_id: ChildIdChild task identifier
path: SupervisorPathFull path of the child task in the supervisor tree.
generation: GenerationGeneration for the runtime slot that owns this child_start_count.
child_start_count: ChildStartCountChildStartCount number for the running task.
Implementations§
Source§impl TaskContext
impl TaskContext
Sourcepub fn new(
child_id: ChildId,
path: SupervisorPath,
generation: Generation,
child_start_count: ChildStartCount,
) -> (Self, Receiver<Option<Instant>>)
pub fn new( child_id: ChildId, path: SupervisorPath, generation: Generation, child_start_count: ChildStartCount, ) -> (Self, Receiver<Option<Instant>>)
Creates a context for a child task.
§Arguments
child_id: Stable child identifier.path: Full supervisor tree path for this child.generation: Runtime slot generation.child_start_count: ChildStartCount number for this execution.
§Returns
Returns the context and a heartbeat receiver for runtime observers.
§Examples
let (ctx, _heartbeat) = rust_supervisor::task::context::TaskContext::new(
rust_supervisor::id::types::ChildId::new("worker"),
rust_supervisor::id::types::SupervisorPath::root().join("worker"),
rust_supervisor::id::types::Generation::initial(),
rust_supervisor::id::types::ChildStartCount::first(),
);
assert!(!ctx.is_cancelled());Sourcepub fn with_ready_signal(
child_id: ChildId,
path: SupervisorPath,
generation: Generation,
child_start_count: ChildStartCount,
ready_signal: ReadySignal,
) -> (Self, Receiver<Option<Instant>>)
pub fn with_ready_signal( child_id: ChildId, path: SupervisorPath, generation: Generation, child_start_count: ChildStartCount, ready_signal: ReadySignal, ) -> (Self, Receiver<Option<Instant>>)
Creates a task context with an existing readiness signal.
§Arguments
child_id: Stable child identifier.path: Full supervisor tree path for this child.generation: Runtime slot generation.child_start_count: ChildStartCount number for this execution.ready_signal: Signal used to publish readiness.
§Returns
Returns the context and a heartbeat receiver for runtime observers.
Sourcepub fn with_ready_signal_and_cancellation_token(
child_id: ChildId,
path: SupervisorPath,
generation: Generation,
child_start_count: ChildStartCount,
ready_signal: ReadySignal,
cancellation_token: CancellationToken,
) -> (Self, Receiver<Option<Instant>>)
pub fn with_ready_signal_and_cancellation_token( child_id: ChildId, path: SupervisorPath, generation: Generation, child_start_count: ChildStartCount, ready_signal: ReadySignal, cancellation_token: CancellationToken, ) -> (Self, Receiver<Option<Instant>>)
Creates a task context with an existing readiness signal and token.
§Arguments
child_id: Stable child identifier.path: Full supervisor tree path for this child.generation: Runtime slot generation.child_start_count: ChildStartCount number for this execution.ready_signal: Signal used to publish readiness.cancellation_token: Token shared with runtime shutdown.
§Returns
Returns the context and a heartbeat receiver for runtime observers.
Sourcepub fn mark_ready(&self)
pub fn mark_ready(&self)
Sourcepub fn set_readiness(&self, state: ReadinessState)
pub fn set_readiness(&self, state: ReadinessState)
Sourcepub fn is_cancelled(&self) -> bool
pub fn is_cancelled(&self) -> bool
Sourcepub fn cancellation_token(&self) -> CancellationToken
pub fn cancellation_token(&self) -> CancellationToken
Sourcepub fn readiness_receiver(&self) -> Receiver<ReadinessState>
pub fn readiness_receiver(&self) -> Receiver<ReadinessState>
Trait Implementations§
Source§impl Clone for TaskContext
impl Clone for TaskContext
Source§fn clone(&self) -> TaskContext
fn clone(&self) -> TaskContext
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for TaskContext
impl !RefUnwindSafe for TaskContext
impl Send for TaskContext
impl Sync for TaskContext
impl Unpin for TaskContext
impl UnsafeUnpin for TaskContext
impl !UnwindSafe for TaskContext
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);