pub struct Shutdown { /* private fields */ }
This is supported on crate feature
shutdown
only.Expand description
Drives shutdown by watching signals
Implementations
sourceimpl Shutdown
impl Shutdown
sourcepub async fn signaled(self) -> Result<(), Aborted>
pub async fn signaled(self) -> Result<(), Aborted>
Watches for signals and drives shutdown
When a SIGINT
or SIGTERM
signal is received, the shutdown is initiated, notifying all
Watch
instances. When all watches are dropped, the shutdown is completed.
If a second signal is received while waiting for watches to be dropped, this future
completes immediately with an Aborted
error.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Shutdown
impl Send for Shutdown
impl Sync for Shutdown
impl Unpin for Shutdown
impl !UnwindSafe for Shutdown
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
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
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more