Skip to main content

SupervisorState

rust_supervisor::state::supervisor

Struct SupervisorState 

Source 
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: SupervisorPath

Root path for this state response.

§generated_at_unix_nanos: u128

Generated time in nanoseconds since the Unix epoch.

§sequence: EventSequence

Sequence assigned to this state generation.

§config_version: u64

Configuration version that produced this state.

§children: BTreeMap<String, ChildState>

Child states indexed by stable path text.

§meltdown_state: MeltdownState

Current meltdown status.

§shutdown_state: ShutdownState

Current shutdown status.

§journal_sequence: Option<EventSequence>

Last event journal sequence known to the state owner.

Implementations§

Source§

impl SupervisorState

Source

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());
Examples found in repository?
examples/diagnostic_replay.rs (line 140)
38fn main() {
39    // Build the child identifier.
40    let child_id = ChildId::new("market_feed");
41    // Build the child path.
42    let child_path = SupervisorPath::root().join("market_feed");
43    // Build a typed task failure.
44    let failure = TaskFailure::new(
45        // Set the failure kind.
46        TaskFailureKind::Timeout,
47        // Set the low-cardinality failure category.
48        "external_dependency",
49        // Set the diagnostic failure message.
50        "market feed heartbeat timed out",
51        // Finish the typed task failure.
52    );
53    // Build the restart policy decision.
54    let policy = PolicyDecision::new(
55        // Set the decision label.
56        "RestartAfter",
57        // Set the restart delay.
58        Some(500),
59        // Set the diagnostic decision reason.
60        Some("heartbeat timeout is restartable".to_owned()),
61        // Finish the policy decision.
62    );
63
64    // Create the fixed-capacity event journal.
65    let mut journal = EventJournal::new(8);
66    // Push the running event.
67    journal.push(event(
68        // Set the event sequence.
69        1,
70        // Clone the child identifier.
71        child_id.clone(),
72        // Set the child display name.
73        "Market Feed",
74        // Build the running event payload.
75        What::ChildRunning {
76            // Attach the state transition.
77            transition: Some(StateTransition::new("Starting", "Running")),
78            // Finish the running event payload.
79        },
80        // Attach no policy decision.
81        None,
82        // Finish the running event.
83    ));
84    // Push the failed event.
85    journal.push(event(
86        // Set the event sequence.
87        2,
88        // Clone the child identifier.
89        child_id.clone(),
90        // Set the child display name.
91        "Market Feed",
92        // Build the failed event payload.
93        What::ChildFailed {
94            // Attach the typed failure.
95            failure: failure.clone(),
96            // Finish the failed event payload.
97        },
98        // Attach the restart policy decision.
99        Some(policy.clone()),
100        // Finish the failed event.
101    ));
102    // Push the backoff event.
103    journal.push(event(
104        // Set the event sequence.
105        3,
106        // Clone the child identifier.
107        child_id.clone(),
108        // Set the child display name.
109        "Market Feed",
110        // Build the backoff payload.
111        What::BackoffScheduled { delay_ms: 500 },
112        // Attach the restart policy decision.
113        Some(policy.clone()),
114        // Finish the backoff event.
115    ));
116    // Push the restarted event.
117    journal.push(event(
118        // Set the event sequence.
119        4,
120        // Clone the child identifier.
121        child_id.clone(),
122        // Set the child display name.
123        "Market Feed",
124        // Build the restarted payload.
125        What::ChildRestarted { restart_count: 1 },
126        // Attach the restart policy decision.
127        Some(policy.clone()),
128        // Finish the restarted event.
129    ));
130
131    // Build the final child state.
132    let child = ChildState::declared(child_path, child_id, "Market Feed")
133        // Set the child lifecycle state.
134        .with_lifecycle_state(ChildLifecycleState::Running, EventSequence::new(1))
135        // Record the latest failure.
136        .record_failure(failure, EventSequence::new(2))
137        // Record the latest policy decision.
138        .with_policy_decision(policy, 1);
139    // Build the final supervisor state.
140    let final_state = SupervisorState::new(SupervisorPath::root(), EventSequence::new(4), 1)
141        // Add the child state.
142        .with_child(child)
143        // Mark shutdown as completed for the replay.
144        .with_shutdown_state(ShutdownState::Completed)
145        // Attach the last journal sequence.
146        .with_journal_sequence(EventSequence::new(4));
147    // Build the diagnostic run summary.
148    let summary = RunSummaryBuilder::new(8).build(
149        // Read recent events from the journal.
150        &journal,
151        // Attach the final current state.
152        final_state,
153        // Attach the shutdown cause.
154        Some("diagnostic replay complete".to_owned()),
155        // Finish the summary construction.
156    );
157    // Create the metrics facade.
158    let metrics = MetricsFacade::new();
159
160    // Print summary counters.
161    println!(
162        // Provide the output template.
163        "summary restart_count={} failure_count={} recent_events={}",
164        // Print the restart count.
165        summary.restart_count,
166        // Print the failure count.
167        summary.failure_count,
168        // Print the recent event count.
169        summary.recent_events.len(),
170        // Finish summary output.
171    );
172    // Iterate over recent journal events.
173    for event in journal.recent(8) {
174        // Print event names and derived metrics.
175        println!(
176            // Provide the output template.
177            "event={} metrics={:?}",
178            // Print the event name.
179            event.what.name(),
180            // Print metrics derived from the event.
181            metrics.samples_for_event(&event),
182            // Finish event output.
183        );
184        // Finish the journal replay loop.
185    }
186    // End the diagnostic replay example.
187}
Source

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.

Examples found in repository?
examples/diagnostic_replay.rs (line 142)
38fn main() {
39    // Build the child identifier.
40    let child_id = ChildId::new("market_feed");
41    // Build the child path.
42    let child_path = SupervisorPath::root().join("market_feed");
43    // Build a typed task failure.
44    let failure = TaskFailure::new(
45        // Set the failure kind.
46        TaskFailureKind::Timeout,
47        // Set the low-cardinality failure category.
48        "external_dependency",
49        // Set the diagnostic failure message.
50        "market feed heartbeat timed out",
51        // Finish the typed task failure.
52    );
53    // Build the restart policy decision.
54    let policy = PolicyDecision::new(
55        // Set the decision label.
56        "RestartAfter",
57        // Set the restart delay.
58        Some(500),
59        // Set the diagnostic decision reason.
60        Some("heartbeat timeout is restartable".to_owned()),
61        // Finish the policy decision.
62    );
63
64    // Create the fixed-capacity event journal.
65    let mut journal = EventJournal::new(8);
66    // Push the running event.
67    journal.push(event(
68        // Set the event sequence.
69        1,
70        // Clone the child identifier.
71        child_id.clone(),
72        // Set the child display name.
73        "Market Feed",
74        // Build the running event payload.
75        What::ChildRunning {
76            // Attach the state transition.
77            transition: Some(StateTransition::new("Starting", "Running")),
78            // Finish the running event payload.
79        },
80        // Attach no policy decision.
81        None,
82        // Finish the running event.
83    ));
84    // Push the failed event.
85    journal.push(event(
86        // Set the event sequence.
87        2,
88        // Clone the child identifier.
89        child_id.clone(),
90        // Set the child display name.
91        "Market Feed",
92        // Build the failed event payload.
93        What::ChildFailed {
94            // Attach the typed failure.
95            failure: failure.clone(),
96            // Finish the failed event payload.
97        },
98        // Attach the restart policy decision.
99        Some(policy.clone()),
100        // Finish the failed event.
101    ));
102    // Push the backoff event.
103    journal.push(event(
104        // Set the event sequence.
105        3,
106        // Clone the child identifier.
107        child_id.clone(),
108        // Set the child display name.
109        "Market Feed",
110        // Build the backoff payload.
111        What::BackoffScheduled { delay_ms: 500 },
112        // Attach the restart policy decision.
113        Some(policy.clone()),
114        // Finish the backoff event.
115    ));
116    // Push the restarted event.
117    journal.push(event(
118        // Set the event sequence.
119        4,
120        // Clone the child identifier.
121        child_id.clone(),
122        // Set the child display name.
123        "Market Feed",
124        // Build the restarted payload.
125        What::ChildRestarted { restart_count: 1 },
126        // Attach the restart policy decision.
127        Some(policy.clone()),
128        // Finish the restarted event.
129    ));
130
131    // Build the final child state.
132    let child = ChildState::declared(child_path, child_id, "Market Feed")
133        // Set the child lifecycle state.
134        .with_lifecycle_state(ChildLifecycleState::Running, EventSequence::new(1))
135        // Record the latest failure.
136        .record_failure(failure, EventSequence::new(2))
137        // Record the latest policy decision.
138        .with_policy_decision(policy, 1);
139    // Build the final supervisor state.
140    let final_state = SupervisorState::new(SupervisorPath::root(), EventSequence::new(4), 1)
141        // Add the child state.
142        .with_child(child)
143        // Mark shutdown as completed for the replay.
144        .with_shutdown_state(ShutdownState::Completed)
145        // Attach the last journal sequence.
146        .with_journal_sequence(EventSequence::new(4));
147    // Build the diagnostic run summary.
148    let summary = RunSummaryBuilder::new(8).build(
149        // Read recent events from the journal.
150        &journal,
151        // Attach the final current state.
152        final_state,
153        // Attach the shutdown cause.
154        Some("diagnostic replay complete".to_owned()),
155        // Finish the summary construction.
156    );
157    // Create the metrics facade.
158    let metrics = MetricsFacade::new();
159
160    // Print summary counters.
161    println!(
162        // Provide the output template.
163        "summary restart_count={} failure_count={} recent_events={}",
164        // Print the restart count.
165        summary.restart_count,
166        // Print the failure count.
167        summary.failure_count,
168        // Print the recent event count.
169        summary.recent_events.len(),
170        // Finish summary output.
171    );
172    // Iterate over recent journal events.
173    for event in journal.recent(8) {
174        // Print event names and derived metrics.
175        println!(
176            // Provide the output template.
177            "event={} metrics={:?}",
178            // Print the event name.
179            event.what.name(),
180            // Print metrics derived from the event.
181            metrics.samples_for_event(&event),
182            // Finish event output.
183        );
184        // Finish the journal replay loop.
185    }
186    // End the diagnostic replay example.
187}
Source

pub fn with_shutdown_state(self, shutdown_state: ShutdownState) -> Self

Updates shutdown state.

§Arguments
  • shutdown_state: New shutdown phase.
§Returns

Returns the updated SupervisorState.

Examples found in repository?
examples/diagnostic_replay.rs (line 144)
38fn main() {
39    // Build the child identifier.
40    let child_id = ChildId::new("market_feed");
41    // Build the child path.
42    let child_path = SupervisorPath::root().join("market_feed");
43    // Build a typed task failure.
44    let failure = TaskFailure::new(
45        // Set the failure kind.
46        TaskFailureKind::Timeout,
47        // Set the low-cardinality failure category.
48        "external_dependency",
49        // Set the diagnostic failure message.
50        "market feed heartbeat timed out",
51        // Finish the typed task failure.
52    );
53    // Build the restart policy decision.
54    let policy = PolicyDecision::new(
55        // Set the decision label.
56        "RestartAfter",
57        // Set the restart delay.
58        Some(500),
59        // Set the diagnostic decision reason.
60        Some("heartbeat timeout is restartable".to_owned()),
61        // Finish the policy decision.
62    );
63
64    // Create the fixed-capacity event journal.
65    let mut journal = EventJournal::new(8);
66    // Push the running event.
67    journal.push(event(
68        // Set the event sequence.
69        1,
70        // Clone the child identifier.
71        child_id.clone(),
72        // Set the child display name.
73        "Market Feed",
74        // Build the running event payload.
75        What::ChildRunning {
76            // Attach the state transition.
77            transition: Some(StateTransition::new("Starting", "Running")),
78            // Finish the running event payload.
79        },
80        // Attach no policy decision.
81        None,
82        // Finish the running event.
83    ));
84    // Push the failed event.
85    journal.push(event(
86        // Set the event sequence.
87        2,
88        // Clone the child identifier.
89        child_id.clone(),
90        // Set the child display name.
91        "Market Feed",
92        // Build the failed event payload.
93        What::ChildFailed {
94            // Attach the typed failure.
95            failure: failure.clone(),
96            // Finish the failed event payload.
97        },
98        // Attach the restart policy decision.
99        Some(policy.clone()),
100        // Finish the failed event.
101    ));
102    // Push the backoff event.
103    journal.push(event(
104        // Set the event sequence.
105        3,
106        // Clone the child identifier.
107        child_id.clone(),
108        // Set the child display name.
109        "Market Feed",
110        // Build the backoff payload.
111        What::BackoffScheduled { delay_ms: 500 },
112        // Attach the restart policy decision.
113        Some(policy.clone()),
114        // Finish the backoff event.
115    ));
116    // Push the restarted event.
117    journal.push(event(
118        // Set the event sequence.
119        4,
120        // Clone the child identifier.
121        child_id.clone(),
122        // Set the child display name.
123        "Market Feed",
124        // Build the restarted payload.
125        What::ChildRestarted { restart_count: 1 },
126        // Attach the restart policy decision.
127        Some(policy.clone()),
128        // Finish the restarted event.
129    ));
130
131    // Build the final child state.
132    let child = ChildState::declared(child_path, child_id, "Market Feed")
133        // Set the child lifecycle state.
134        .with_lifecycle_state(ChildLifecycleState::Running, EventSequence::new(1))
135        // Record the latest failure.
136        .record_failure(failure, EventSequence::new(2))
137        // Record the latest policy decision.
138        .with_policy_decision(policy, 1);
139    // Build the final supervisor state.
140    let final_state = SupervisorState::new(SupervisorPath::root(), EventSequence::new(4), 1)
141        // Add the child state.
142        .with_child(child)
143        // Mark shutdown as completed for the replay.
144        .with_shutdown_state(ShutdownState::Completed)
145        // Attach the last journal sequence.
146        .with_journal_sequence(EventSequence::new(4));
147    // Build the diagnostic run summary.
148    let summary = RunSummaryBuilder::new(8).build(
149        // Read recent events from the journal.
150        &journal,
151        // Attach the final current state.
152        final_state,
153        // Attach the shutdown cause.
154        Some("diagnostic replay complete".to_owned()),
155        // Finish the summary construction.
156    );
157    // Create the metrics facade.
158    let metrics = MetricsFacade::new();
159
160    // Print summary counters.
161    println!(
162        // Provide the output template.
163        "summary restart_count={} failure_count={} recent_events={}",
164        // Print the restart count.
165        summary.restart_count,
166        // Print the failure count.
167        summary.failure_count,
168        // Print the recent event count.
169        summary.recent_events.len(),
170        // Finish summary output.
171    );
172    // Iterate over recent journal events.
173    for event in journal.recent(8) {
174        // Print event names and derived metrics.
175        println!(
176            // Provide the output template.
177            "event={} metrics={:?}",
178            // Print the event name.
179            event.what.name(),
180            // Print metrics derived from the event.
181            metrics.samples_for_event(&event),
182            // Finish event output.
183        );
184        // Finish the journal replay loop.
185    }
186    // End the diagnostic replay example.
187}
Source

pub fn with_meltdown_state(self, meltdown_state: MeltdownState) -> Self

Updates meltdown state.

§Arguments
  • meltdown_state: New meltdown state.
§Returns

Returns the updated SupervisorState.

Source

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.

Examples found in repository?
examples/diagnostic_replay.rs (line 146)
38fn main() {
39    // Build the child identifier.
40    let child_id = ChildId::new("market_feed");
41    // Build the child path.
42    let child_path = SupervisorPath::root().join("market_feed");
43    // Build a typed task failure.
44    let failure = TaskFailure::new(
45        // Set the failure kind.
46        TaskFailureKind::Timeout,
47        // Set the low-cardinality failure category.
48        "external_dependency",
49        // Set the diagnostic failure message.
50        "market feed heartbeat timed out",
51        // Finish the typed task failure.
52    );
53    // Build the restart policy decision.
54    let policy = PolicyDecision::new(
55        // Set the decision label.
56        "RestartAfter",
57        // Set the restart delay.
58        Some(500),
59        // Set the diagnostic decision reason.
60        Some("heartbeat timeout is restartable".to_owned()),
61        // Finish the policy decision.
62    );
63
64    // Create the fixed-capacity event journal.
65    let mut journal = EventJournal::new(8);
66    // Push the running event.
67    journal.push(event(
68        // Set the event sequence.
69        1,
70        // Clone the child identifier.
71        child_id.clone(),
72        // Set the child display name.
73        "Market Feed",
74        // Build the running event payload.
75        What::ChildRunning {
76            // Attach the state transition.
77            transition: Some(StateTransition::new("Starting", "Running")),
78            // Finish the running event payload.
79        },
80        // Attach no policy decision.
81        None,
82        // Finish the running event.
83    ));
84    // Push the failed event.
85    journal.push(event(
86        // Set the event sequence.
87        2,
88        // Clone the child identifier.
89        child_id.clone(),
90        // Set the child display name.
91        "Market Feed",
92        // Build the failed event payload.
93        What::ChildFailed {
94            // Attach the typed failure.
95            failure: failure.clone(),
96            // Finish the failed event payload.
97        },
98        // Attach the restart policy decision.
99        Some(policy.clone()),
100        // Finish the failed event.
101    ));
102    // Push the backoff event.
103    journal.push(event(
104        // Set the event sequence.
105        3,
106        // Clone the child identifier.
107        child_id.clone(),
108        // Set the child display name.
109        "Market Feed",
110        // Build the backoff payload.
111        What::BackoffScheduled { delay_ms: 500 },
112        // Attach the restart policy decision.
113        Some(policy.clone()),
114        // Finish the backoff event.
115    ));
116    // Push the restarted event.
117    journal.push(event(
118        // Set the event sequence.
119        4,
120        // Clone the child identifier.
121        child_id.clone(),
122        // Set the child display name.
123        "Market Feed",
124        // Build the restarted payload.
125        What::ChildRestarted { restart_count: 1 },
126        // Attach the restart policy decision.
127        Some(policy.clone()),
128        // Finish the restarted event.
129    ));
130
131    // Build the final child state.
132    let child = ChildState::declared(child_path, child_id, "Market Feed")
133        // Set the child lifecycle state.
134        .with_lifecycle_state(ChildLifecycleState::Running, EventSequence::new(1))
135        // Record the latest failure.
136        .record_failure(failure, EventSequence::new(2))
137        // Record the latest policy decision.
138        .with_policy_decision(policy, 1);
139    // Build the final supervisor state.
140    let final_state = SupervisorState::new(SupervisorPath::root(), EventSequence::new(4), 1)
141        // Add the child state.
142        .with_child(child)
143        // Mark shutdown as completed for the replay.
144        .with_shutdown_state(ShutdownState::Completed)
145        // Attach the last journal sequence.
146        .with_journal_sequence(EventSequence::new(4));
147    // Build the diagnostic run summary.
148    let summary = RunSummaryBuilder::new(8).build(
149        // Read recent events from the journal.
150        &journal,
151        // Attach the final current state.
152        final_state,
153        // Attach the shutdown cause.
154        Some("diagnostic replay complete".to_owned()),
155        // Finish the summary construction.
156    );
157    // Create the metrics facade.
158    let metrics = MetricsFacade::new();
159
160    // Print summary counters.
161    println!(
162        // Provide the output template.
163        "summary restart_count={} failure_count={} recent_events={}",
164        // Print the restart count.
165        summary.restart_count,
166        // Print the failure count.
167        summary.failure_count,
168        // Print the recent event count.
169        summary.recent_events.len(),
170        // Finish summary output.
171    );
172    // Iterate over recent journal events.
173    for event in journal.recent(8) {
174        // Print event names and derived metrics.
175        println!(
176            // Provide the output template.
177            "event={} metrics={:?}",
178            // Print the event name.
179            event.what.name(),
180            // Print metrics derived from the event.
181            metrics.samples_for_event(&event),
182            // Finish event output.
183        );
184        // Finish the journal replay loop.
185    }
186    // End the diagnostic replay example.
187}

Trait Implementations§

Source§

impl Clone for SupervisorState

Source§

fn clone(&self) -> SupervisorState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SupervisorState

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SupervisorState

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SupervisorState

Source§

fn eq(&self, other: &SupervisorState) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for SupervisorState

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for SupervisorState

Source§

impl StructuralPartialEq for SupervisorState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,