pub struct SupervisorInstanceGate { /* private fields */ }Expand description
Instance-global concurrent restart gate counter.
Tracks the number of currently active restart attempts across all children supervised by this supervisor instance. When the limit is reached, new restart requests are queued or denied based on protection policy.
Implementations§
Source§impl SupervisorInstanceGate
impl SupervisorInstanceGate
Sourcepub fn new(max_concurrent: u32) -> Self
pub fn new(max_concurrent: u32) -> Self
Creates a new instance-global concurrent restart gate.
§Arguments
max_concurrent: Maximum number of concurrent restart attempts allowed.
§Returns
Returns a new SupervisorInstanceGate with zero active count.
§Examples
use rust_supervisor::runtime::concurrent_gate::SupervisorInstanceGate;
let gate = SupervisorInstanceGate::new(5);
assert_eq!(gate.get_active_count(), 0);Sourcepub fn try_acquire(&self) -> bool
pub fn try_acquire(&self) -> bool
Attempts to acquire a restart slot from the instance gate.
§Returns
Returns true if a slot was successfully acquired (active count < limit),
false if the gate is saturated (active count >= limit).
§Examples
use rust_supervisor::runtime::concurrent_gate::SupervisorInstanceGate;
let gate = SupervisorInstanceGate::new(2);
assert!(gate.try_acquire()); // First acquisition succeeds
assert!(gate.try_acquire()); // Second acquisition succeeds
assert!(!gate.try_acquire()); // Third acquisition fails (limit reached)Sourcepub fn release(&self)
pub fn release(&self)
Releases a restart slot after restart initiation completes.
NOTE: The gate counter is decremented immediately when restart starts, not when restart finishes. If the supervisor crashes before restart completes, the slot is reclaimed by timeout or garbage collection.
§Examples
use rust_supervisor::runtime::concurrent_gate::SupervisorInstanceGate;
let gate = SupervisorInstanceGate::new(2);
gate.try_acquire();
gate.release();
assert_eq!(gate.get_active_count(), 0);Sourcepub fn get_active_count(&self) -> u32
pub fn get_active_count(&self) -> u32
Returns the current number of active restart attempts.
§Returns
Returns the current active count for monitoring and diagnostics.
Sourcepub fn get_max_concurrent(&self) -> u32
pub fn get_max_concurrent(&self) -> u32
Returns the configured maximum concurrent restart limit.
§Returns
Returns the maximum allowed concurrent restarts.
Sourcepub fn is_saturated(&self) -> bool
pub fn is_saturated(&self) -> bool
Checks if the gate is currently saturated.
§Returns
Returns true if active count has reached or exceeded the limit.
Trait Implementations§
Source§impl Clone for SupervisorInstanceGate
impl Clone for SupervisorInstanceGate
Source§fn clone(&self) -> SupervisorInstanceGate
fn clone(&self) -> SupervisorInstanceGate
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 SupervisorInstanceGate
impl RefUnwindSafe for SupervisorInstanceGate
impl Send for SupervisorInstanceGate
impl Sync for SupervisorInstanceGate
impl Unpin for SupervisorInstanceGate
impl UnsafeUnpin for SupervisorInstanceGate
impl UnwindSafe for SupervisorInstanceGate
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);