Struct CtrlcBuilder 

pub struct CtrlcBuilder { /* private fields */ }

Available on crate feature print only.

Builder for a new frame for handling Ctrl-C signals. The canonical factory function for this is cu::cli::ctrlc_frame. See Handling Ctrl-C.

Implementations

impl CtrlcBuilder

pub fn abort_threshold(self, threshold: u8) -> Self

Set the number of Ctrl-C signals required for the task to be considered aborted (where the return will be Ok(None).

Default is 1

pub fn on_signal<F: Fn(CtrlcSignal) + Send + 'static>(self, f: F) -> Self

Set a function to be called when Ctrl-C signal is received.

The function will be executed on the Ctrl-C signal handling thread, not the thread that runs the task, and is

pub fn execute<T, F>(self, f: F) -> Result<Option<T>>

where F: FnOnce(CtrlcSignal) -> Result<T>,

Execute the task

pub async fn co_execute<T, TFuture, F>(self, f: F) -> Result<Option<T>>

where TFuture: Future<Output = Result<T>>, F: FnOnce(CtrlcSignal) -> TFuture,

Available on crate feature coroutine only.

Trait Implementations

impl Default for CtrlcBuilder

fn default() -> Self

Returns the “default value” for a type.