[][src]Struct grace::ShutdownGuard

pub struct ShutdownGuard<'a> { /* fields omitted */ }

This is the primary interface to the crate.

Construct an instance of this type to begin intercepting shutdown requests. When the guard is dropped, shutdown requests will no longer be intercepted.

There are several constructors to simplify common usage patterns.

Implementations

impl<'a> ShutdownGuard<'a>[src]

pub fn new<H: Handler>(types: &'a [ShutdownType], handler: H) -> Self[src]

Call a user-defined function whenever a shutdown is requested.

pub fn new_channel(types: &'a [ShutdownType]) -> (Self, Receiver<ShutdownType>)[src]

Send on an mpsc channel whenever a shutdown is requested.

pub fn forget(self)[src]

Forget this guard, leaving the shutdown handler installed for the lifetime of the program.

Trait Implementations

impl<'a> Drop for ShutdownGuard<'a>[src]

Auto Trait Implementations

impl<'a> !RefUnwindSafe for ShutdownGuard<'a>[src]

impl<'a> !Send for ShutdownGuard<'a>[src]

impl<'a> !Sync for ShutdownGuard<'a>[src]

impl<'a> Unpin for ShutdownGuard<'a>[src]

impl<'a> !UnwindSafe for ShutdownGuard<'a>[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.