Enum paxakos::event::ShutdownEvent

source · [−]

pub enum ShutdownEvent<I: Invocation> {
    Regular(Event<I>),
    Final {
        snapshot: SnapshotFor<I>,
    },
}

Expand description

Emitted by Shutdown’s poll_shutdown method.

Variants

`Regular(Event)`

Regular event emitted during the shutdown process.

`Final`

Fields

This variant is marked as non-exhaustive

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

snapshot: SnapshotFor

Snapshot that may be used to restart the node via [resuming_from][crate::NodeBuilderWithNodeIdAndCommunicator:: resuming_from].

Final event of the shutdown process.

When this event is received the shutdown procedure has completed.

Trait Implementations

source

impl<I: Invocation> Debug for ShutdownEvent

source

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

Formats the value using the given formatter. Read more

source

impl<I: Invocation> From<Event> for ShutdownEvent

source

fn from(e: Event) -> Self

Converts to this type from the input type.

Auto Trait Implementations

impl RefUnwindSafe for ShutdownEvent where
 ::CoordNum: RefUnwindSafe,
 <::State as State>::Effect: RefUnwindSafe,
 ::Ejection: RefUnwindSafe,
 <::State as State>::Frozen: RefUnwindSafe,
 <::State as State>::LogEntry: RefUnwindSafe,
 <::State as State>::Node: RefUnwindSafe,
 ::RoundNum: RefUnwindSafe,
 ::State: RefUnwindSafe,

impl Send for ShutdownEvent

impl Sync for ShutdownEvent where
<::State as State>::Effect: Sync,

impl Unpin for ShutdownEvent where
 <::State as State>::Effect: Unpin,
 ::Ejection: Unpin,
 <::State as State>::Node: Unpin,
 ::State: Unpin,

impl UnwindSafe for ShutdownEvent where
 ::CoordNum: UnwindSafe + RefUnwindSafe,
 <::State as State>::Effect: UnwindSafe,
 ::Ejection: UnwindSafe,
 <::State as State>::Frozen: RefUnwindSafe,
 <::State as State>::LogEntry: RefUnwindSafe,
 <::State as State>::Node: UnwindSafe,
 ::RoundNum: UnwindSafe + RefUnwindSafe,
 ::State: 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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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 for T where
U: From<T>,

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

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

Enum paxakos::event::ShutdownEvent

Variants

`Regular(Event<I>)`

`Final`

Fields

Trait Implementations

impl<I: Invocation> Debug for ShutdownEvent<I>

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

impl<I: Invocation> From<Event<I>> for ShutdownEvent<I>

fn from(e: Event<I>) -> Self

Auto Trait Implementations

impl<I> Send for ShutdownEvent<I>

impl<I> Sync for ShutdownEvent<I> where
<<I as Invocation>::State as State>::Effect: Sync,

impl<I> Unpin for ShutdownEvent<I> where
    <<I as Invocation>::State as State>::Effect: Unpin,
    <I as Invocation>::Ejection: Unpin,
    <<I as Invocation>::State as State>::Node: Unpin,
    <I as Invocation>::State: Unpin,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where
U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

Enum paxakos::event::ShutdownEvent

Variants

Regular(Event<I>)

Final

Fields

Trait Implementations

impl<I: Invocation> Debug for ShutdownEvent<I>

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

impl<I: Invocation> From<Event<I>> for ShutdownEvent<I>

fn from(e: Event<I>) -> Self

Auto Trait Implementations

impl<I> Send for ShutdownEvent<I>

impl<I> Sync for ShutdownEvent<I> where <<I as Invocation>::State as State>::Effect: Sync,

impl<I> Unpin for ShutdownEvent<I> where <<I as Invocation>::State as State>::Effect: Unpin, <I as Invocation>::Ejection: Unpin, <<I as Invocation>::State as State>::Node: Unpin, <I as Invocation>::State: Unpin,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

`Regular(Event<I>)`

`Final`

impl<I> Sync for ShutdownEvent<I> where
<<I as Invocation>::State as State>::Effect: Sync,

impl<I> Unpin for ShutdownEvent<I> where
<<I as Invocation>::State as State>::Effect: Unpin,
<I as Invocation>::Ejection: Unpin,
<<I as Invocation>::State as State>::Node: Unpin,
<I as Invocation>::State: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,