Skip to main content

StartupCoordinator

Struct StartupCoordinator 

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

Ordered startup phase coordinator.

The coordinator owns phase ordering, failure policy handling, duration collection, and tracing. Product crates provide closures for the actual startup work and decide how to map report data into their own diagnostics or admin surfaces.

Implementations§

Source§

impl StartupCoordinator

Source

pub fn new() -> Self

Creates an empty startup coordinator.

Source

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

Registers a required startup phase.

Source

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

Registers an optional startup phase.

Source

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

Registers a startup phase with an explicit failure policy.

Source

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

Runs registered phases in order.

Required phase failures stop later phases. Optional phase failures are logged and included in the report while later phases continue.

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 StartupCoordinator

Source§

fn default() -> StartupCoordinator

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