Skip to main content

ApplicationLifecycle

Struct ApplicationLifecycle 

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

Shared process-local readiness and graceful-drain coordinator.

Required component labels are immutable and intentionally absent from the public health payload. Applications update them only after performing their own authenticated dependency checks. This type does not discover services, coordinate replicas, or authorize domain requests.

Implementations§

Source§

impl ApplicationLifecycle

Source

pub fn new() -> Self

Creates a lifecycle in the Starting phase without required components.

Source

pub fn with_required_components<I, S>( components: I, ) -> Result<Self, ApplicationLifecycleError>
where I: IntoIterator<Item = S>, S: Into<String>,

Creates a lifecycle with an immutable bounded set of required components.

Source

pub fn phase(&self) -> ApplicationPhase

Returns the current monotonic phase.

Source

pub fn mark_ready(&self) -> Result<(), ApplicationLifecycleError>

Marks startup complete without overriding required component states.

Source

pub fn set_component_ready( &self, component: impl Into<String>, ready: bool, ) -> Result<(), ApplicationLifecycleError>

Updates one pre-registered dependency readiness bit.

Source

pub fn begin_draining(&self) -> Result<(), ApplicationLifecycleError>

Begins a monotonic drain and rejects all subsequent application requests.

Source

pub fn mark_stopped(&self)

Marks the lifecycle stopped. This terminal transition is idempotent.

Source

pub fn snapshot(&self) -> ReadinessSnapshot

Returns a secret-minimized readiness snapshot.

Source

pub fn in_flight_requests(&self) -> usize

Returns admitted requests whose handler or HTTP response body is still active. Upgraded connections and detached background work require separate tracking.

Source

pub async fn wait_for_drain( &self, timeout: Duration, ) -> Result<(), ApplicationLifecycleError>

Waits for admitted handlers and response bodies to finish or be dropped. This does not wait for client acknowledgement or upgraded connections.

Trait Implementations§

Source§

impl Clone for ApplicationLifecycle

Source§

fn clone(&self) -> Self

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 ApplicationLifecycle

Source§

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

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

impl Default for ApplicationLifecycle

Source§

fn default() -> Self

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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