Skip to main content

ShutdownState

Enum ShutdownState 

Source
pub enum ShutdownState<P, N> {
    AwaitingPlan,
    AwaitingPlanAfterShutdown,
    Ready {
        plan: P,
    },
    Stopping {
        plan: P,
        phase: usize,
        awaiting: Vec<N>,
    },
    Completed,
}
Expand description

Complete phase of coordinated shutdown, including plan installation.

The installed plan remains owned by the exact phase in which it is valid. A shutdown request received before installation has its own state and is discharged immediately when a plan later arrives. No correlated readiness flag or optional plan can describe a contradictory combination.

Variants§

§

AwaitingPlan

Child establishment has not yet produced the plan.

§

AwaitingPlanAfterShutdown

Shutdown was requested while child establishment was incomplete.

§

Ready

The validated plan is installed and shutdown has not been requested.

Fields

§plan: P
§

Stopping

One plan phase is active and owns its outstanding child IDs.

Fields

§plan: P
§phase: usize
§awaiting: Vec<N>
§

Completed

Every configured phase completed, or the installed plan was empty.

Trait Implementations§

Source§

impl<P: Clone, N: Clone> Clone for ShutdownState<P, N>

Source§

fn clone(&self) -> ShutdownState<P, N>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<P: Debug, N: Debug> Debug for ShutdownState<P, N>

Source§

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

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

impl<P: PartialEq, N: PartialEq> PartialEq for ShutdownState<P, N>

Source§

fn eq(&self, other: &ShutdownState<P, N>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<P: Eq, N: Eq> Eq for ShutdownState<P, N>

Source§

impl<P, N> StructuralPartialEq for ShutdownState<P, N>

Auto Trait Implementations§

§

impl<P, N> Freeze for ShutdownState<P, N>
where P: Freeze,

§

impl<P, N> RefUnwindSafe for ShutdownState<P, N>

§

impl<P, N> Send for ShutdownState<P, N>
where P: Send, N: Send,

§

impl<P, N> Sync for ShutdownState<P, N>
where P: Sync, N: Sync,

§

impl<P, N> Unpin for ShutdownState<P, N>
where P: Unpin, N: Unpin,

§

impl<P, N> UnsafeUnpin for ShutdownState<P, N>
where P: UnsafeUnpin,

§

impl<P, N> UnwindSafe for ShutdownState<P, N>
where P: UnwindSafe, N: UnwindSafe,

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> 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, 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> 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 = 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.