pub struct ChildControlResult {Show 14 fields
pub child_id: ChildId,
pub attempt: Option<ChildStartCount>,
pub generation: Option<Generation>,
pub operation_before: ChildControlOperation,
pub operation_after: ChildControlOperation,
pub status: Option<ChildAttemptStatus>,
pub cancel_delivered: bool,
pub stop_state: ChildStopState,
pub restart_limit: RestartLimitState,
pub liveness: ChildLivenessState,
pub idempotent: bool,
pub failure: Option<ChildControlFailure>,
pub generation_fence: Option<GenerationFenceOutcome>,
pub admission_conflict: Option<AdmissionConflict>,
}Expand description
Result returned by a child control command.
Fields§
§child_id: ChildIdStable child identifier.
attempt: Option<ChildStartCount>Active attempt targeted by the command.
generation: Option<Generation>Active generation targeted by the command.
operation_before: ChildControlOperationControl operation before command handling.
operation_after: ChildControlOperationControl operation after command handling.
status: Option<ChildAttemptStatus>Current attempt status.
cancel_delivered: boolWhether this command delivered cancellation.
stop_state: ChildStopStateStop progress after command handling.
restart_limit: RestartLimitStateCurrent restart limit state.
liveness: ChildLivenessStateCurrent liveness state.
idempotent: boolWhether this command reused existing state idempotently.
failure: Option<ChildControlFailure>Current failure reason.
generation_fence: Option<GenerationFenceOutcome>Optional generation fencing outcome exclusively used by restart control commands.
admission_conflict: Option<AdmissionConflict>Admission conflict detail when a concurrent request was rejected.
Implementations§
Source§impl ChildControlResult
impl ChildControlResult
Sourcepub fn new(
child_id: ChildId,
attempt: Option<ChildStartCount>,
generation: Option<Generation>,
operation_before: ChildControlOperation,
operation_after: ChildControlOperation,
status: Option<ChildAttemptStatus>,
cancel_delivered: bool,
stop_state: ChildStopState,
restart_limit: RestartLimitState,
liveness: ChildLivenessState,
idempotent: bool,
failure: Option<ChildControlFailure>,
generation_fence: Option<GenerationFenceOutcome>,
) -> Self
pub fn new( child_id: ChildId, attempt: Option<ChildStartCount>, generation: Option<Generation>, operation_before: ChildControlOperation, operation_after: ChildControlOperation, status: Option<ChildAttemptStatus>, cancel_delivered: bool, stop_state: ChildStopState, restart_limit: RestartLimitState, liveness: ChildLivenessState, idempotent: bool, failure: Option<ChildControlFailure>, generation_fence: Option<GenerationFenceOutcome>, ) -> Self
Creates a child control result.
§Arguments
child_id: Stable child identifier.attempt: Active attempt targeted by the command.generation: Active generation targeted by the command.operation_before: Control operation before command handling.operation_after: Control operation after command handling.status: Current attempt status.cancel_delivered: Whether this command delivered cancellation.stop_state: Stop progress after command handling.restart_limit: Current restart limit state.liveness: Current liveness state.idempotent: Whether this command reused existing state idempotently.failure: Current failure reason.generation_fence: Optional restart-only fencing outcome payload.
§Returns
Returns a ChildControlResult value.
Sourcepub fn conflict(child_id: ChildId, conflict: AdmissionConflict) -> Self
pub fn conflict(child_id: ChildId, conflict: AdmissionConflict) -> Self
Creates a conflict result when admission is denied.
§Arguments
child_id: Child that already has an active attempt.conflict: Admission conflict detail.
§Returns
Returns a ChildControlResult carrying the conflict.
Trait Implementations§
Source§impl Clone for ChildControlResult
impl Clone for ChildControlResult
Source§fn clone(&self) -> ChildControlResult
fn clone(&self) -> ChildControlResult
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ChildControlResult
impl Debug for ChildControlResult
Source§impl<'de> Deserialize<'de> for ChildControlResult
impl<'de> Deserialize<'de> for ChildControlResult
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl PartialEq for ChildControlResult
impl PartialEq for ChildControlResult
Source§fn eq(&self, other: &ChildControlResult) -> bool
fn eq(&self, other: &ChildControlResult) -> bool
self and other values to be equal, and is used by ==.Source§impl Serialize for ChildControlResult
impl Serialize for ChildControlResult
impl Eq for ChildControlResult
impl StructuralPartialEq for ChildControlResult
Auto Trait Implementations§
impl Freeze for ChildControlResult
impl RefUnwindSafe for ChildControlResult
impl Send for ChildControlResult
impl Sync for ChildControlResult
impl Unpin for ChildControlResult
impl UnsafeUnpin for ChildControlResult
impl UnwindSafe for ChildControlResult
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<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.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);