pub struct SupervisorState {
pub root_path: SupervisorPath,
pub generated_at_unix_nanos: u128,
pub sequence: EventSequence,
pub config_version: u64,
pub children: BTreeMap<String, ChildState>,
pub meltdown_state: MeltdownState,
pub shutdown_state: ShutdownState,
pub journal_sequence: Option<EventSequence>,
}Expand description
Current state for a supervisor tree.
Fields§
§root_path: SupervisorPathRoot path for this state response.
generated_at_unix_nanos: u128Generated time in nanoseconds since the Unix epoch.
sequence: EventSequenceSequence assigned to this state generation.
config_version: u64Configuration version that produced this state.
children: BTreeMap<String, ChildState>Child states indexed by stable path text.
meltdown_state: MeltdownStateCurrent meltdown status.
shutdown_state: ShutdownStateCurrent shutdown status.
journal_sequence: Option<EventSequence>Last event journal sequence known to the state owner.
Implementations§
Source§impl SupervisorState
impl SupervisorState
Sourcepub fn new(
root_path: SupervisorPath,
sequence: EventSequence,
config_version: u64,
) -> Self
pub fn new( root_path: SupervisorPath, sequence: EventSequence, config_version: u64, ) -> Self
Creates an empty supervisor current state.
§Arguments
root_path: Root path for the state response.sequence: State generation sequence.config_version: Configuration version that produced the state.
§Returns
Returns a SupervisorState without children.
§Examples
let state = rust_supervisor::state::supervisor::SupervisorState::new(
rust_supervisor::id::types::SupervisorPath::root(),
rust_supervisor::event::time::EventSequence::new(1),
1,
);
assert!(state.children.is_empty());Sourcepub fn with_child(self, child: ChildState) -> Self
pub fn with_child(self, child: ChildState) -> Self
Inserts or replaces one child state.
§Arguments
child: Current state for one child.
§Returns
Returns the updated SupervisorState.
Sourcepub fn with_shutdown_state(self, shutdown_state: ShutdownState) -> Self
pub fn with_shutdown_state(self, shutdown_state: ShutdownState) -> Self
Updates shutdown state.
§Arguments
shutdown_state: New shutdown phase.
§Returns
Returns the updated SupervisorState.
Sourcepub fn with_meltdown_state(self, meltdown_state: MeltdownState) -> Self
pub fn with_meltdown_state(self, meltdown_state: MeltdownState) -> Self
Updates meltdown state.
§Arguments
meltdown_state: New meltdown state.
§Returns
Returns the updated SupervisorState.
Sourcepub fn with_journal_sequence(self, journal_sequence: EventSequence) -> Self
pub fn with_journal_sequence(self, journal_sequence: EventSequence) -> Self
Records the latest journal sequence known to this state.
§Arguments
journal_sequence: Latest event sequence from the journal.
§Returns
Returns the updated SupervisorState.
Trait Implementations§
Source§impl Clone for SupervisorState
impl Clone for SupervisorState
Source§fn clone(&self) -> SupervisorState
fn clone(&self) -> SupervisorState
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 SupervisorState
impl Debug for SupervisorState
Source§impl<'de> Deserialize<'de> for SupervisorState
impl<'de> Deserialize<'de> for SupervisorState
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 SupervisorState
impl PartialEq for SupervisorState
Source§fn eq(&self, other: &SupervisorState) -> bool
fn eq(&self, other: &SupervisorState) -> bool
self and other values to be equal, and is used by ==.Source§impl Serialize for SupervisorState
impl Serialize for SupervisorState
impl Eq for SupervisorState
impl StructuralPartialEq for SupervisorState
Auto Trait Implementations§
impl Freeze for SupervisorState
impl RefUnwindSafe for SupervisorState
impl Send for SupervisorState
impl Sync for SupervisorState
impl Unpin for SupervisorState
impl UnsafeUnpin for SupervisorState
impl UnwindSafe for SupervisorState
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);