Struct AsyncCtrlC 

pub struct AsyncCtrlC { /* private fields */ }

A future which is fulfilled when the program receives the Ctrl+C signal.

Implementations

impl AsyncCtrlC

pub fn new<F>(user_handler: F) -> Result<Self>

where F: FnMut() -> bool + 'static + Send,

Creates a new AsyncCtrlC future.

There should be at most one AsyncCtrlC instance in the whole program. The second call to AsyncCtrlC::new() would return an error.

The user_handler function is customizable and the return boolean value is indicating whether the user agreed terminate the program or not.

Trait Implementations

impl Debug for AsyncCtrlC

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

Formats the value using the given formatter.

impl Drop for AsyncCtrlC

fn drop(&mut self)

Executes the destructor for this type.

impl Future for AsyncCtrlC

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.