Skip to main content

ShutdownCoordinator

Struct ShutdownCoordinator 

Source
pub struct ShutdownCoordinator { /* private fields */ }
Expand description

Ordered shutdown phase coordinator.

The coordinator owns phase ordering, timeout handling, duration collection, and error aggregation. Product crates provide the actual phase closures. Phases are FnMut so shutdown code can move owned handles into the coordinator and consume them exactly once during the shutdown run.

Implementations§

Source§

impl ShutdownCoordinator

Source

pub fn new() -> Self

Creates an empty shutdown coordinator.

Source

pub fn phase<F, Fut>( &mut self, name: &'static str, timeout: Option<Duration>, phase: F, ) -> &mut Self
where F: FnMut() -> Fut + Send + 'static, Fut: Future<Output = Result<(), String>> + Send + 'static,

Registers a shutdown phase.

Source

pub async fn run(&mut self) -> ShutdownReport

Runs phases sequentially and returns a report.

Later phases still run when an earlier phase fails. This lets product shutdown code make best-effort progress through independent resources.

Source

pub fn len(&self) -> usize

Returns how many phases are registered.

Source

pub fn is_empty(&self) -> bool

Returns whether no phases are registered.

Trait Implementations§

Source§

impl Default for ShutdownCoordinator

Source§

fn default() -> ShutdownCoordinator

Returns the “default value” for a type. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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