Struct TreeShutdownPolicy 

pub struct TreeShutdownPolicy {
    pub budget: ShutdownBudget,
    pub abort_after_timeout: bool,
    pub force_kill_margin: Duration,
    pub max_orphan_threshold: u32,
}

Shutdown timing policy for a supervisor tree.

Fields

budget: ShutdownBudget

Default cooperative stop budget inherited by children without an override.

abort_after_timeout: bool

Whether asynchronous stragglers may be aborted after the timeout.

force_kill_margin: Duration

Extra grace beyond the tree budget before the global hard deadline.

max_orphan_threshold: u32

Maximum orphaned child tasks before controlled process exit.

When set to 0, the threshold is computed automatically from worker count.

Implementations

impl TreeShutdownPolicy

pub fn effective_global_deadline(&self) -> Duration

Returns the total duration budget for the global shutdown hard deadline: budget.graceful_timeout + budget.abort_wait + force_kill_margin.

Arguments

This function has no arguments.

Returns

Returns the total Duration.

Examples

use std::time::Duration;
use rust_supervisor::spec::shutdown::{ShutdownBudget, TreeShutdownPolicy};

let policy = TreeShutdownPolicy::new(
    ShutdownBudget::new(Duration::from_secs(5), Duration::from_secs(1)),
    true,
    Duration::from_secs(5),
    0,
);
assert_eq!(
    policy.effective_global_deadline(),
    Duration::from_secs(11),
);

pub fn effective_max_orphan_threshold(&self) -> u32

Returns the effective orphan threshold.

When max_orphan_threshold is 0 (default), computes the threshold from the number of tokio worker threads: max(1, ceil(num_worker_threads * 0.25)).

Arguments

This function has no arguments.

Returns

Returns the effective orphan threshold.

impl TreeShutdownPolicy

pub fn new( budget: ShutdownBudget, abort_after_timeout: bool, force_kill_margin: Duration, max_orphan_threshold: u32, ) -> Self

Creates a tree shutdown policy.

Arguments

• budget: Default cooperative stop budget for the tree.
• abort_after_timeout: Whether async stragglers may be aborted.
• force_kill_margin: Extra grace before the global hard deadline.
• max_orphan_threshold: Max orphan count before process exit. Pass 0 to compute automatically.

Returns

Returns a TreeShutdownPolicy.

pub fn with_budget(budget: ShutdownBudget) -> Self

Creates a tree policy from one budget and recommended tree defaults.

Arguments

• budget: Default cooperative stop budget for the tree.

Returns

Returns a TreeShutdownPolicy with abort enabled and automatic orphan threshold.

Trait Implementations

impl Clone for TreeShutdownPolicy

fn clone(&self) -> TreeShutdownPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TreeShutdownPolicy

impl Debug for TreeShutdownPolicy

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

Formats the value using the given formatter.

impl Default for TreeShutdownPolicy

fn default() -> Self

Returns the recommended tree shutdown policy.

impl<'de> Deserialize<'de> for TreeShutdownPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TreeShutdownPolicy

impl JsonSchema for TreeShutdownPolicy

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for TreeShutdownPolicy

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for TreeShutdownPolicy

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TreeShutdownPolicy