Struct SignalSvc

pub struct SignalSvc;

Available on crate feature bootstrap only.

A [Service] that listens for signals and cancels the context when a signal is received.

Trait Implementations

impl Clone for SignalSvc

fn clone(&self) -> SignalSvc

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SignalSvc

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

Formats the value using the given formatter.

impl Default for SignalSvc

fn default() -> SignalSvc

Returns the “default value” for a type.

impl<Global: SignalConfig> Service<Global> for SignalSvc

fn enabled( &self, global: &Arc<Global>, ) -> impl Future<Output = Result<bool>> + Send

Initialize the service and return Ok(true) if the service should be run.

async fn run(self, global: Arc<Global>, ctx: Context) -> Result<()>

Run the service. This function should return a future that is pending as long as the service is running. When the service finishes without any errors, the future should resolve to Ok(()). As a best practice, the service should stop as soon as the provided context is done.

fn name(&self) -> Option<&'static str>

Returns the name of the service, if any.

impl Copy for SignalSvc