pub struct Handle { /* private fields */ }
Expand description

A struct to control an instance of an associated type (like for example Signals).

It allows to register more signal handlers and to shutdown the signal delivery. You can clone this type which isn’t a very expensive operation. The cloned instances can be shared between multiple threads.

Implementations

Registers another signal to the set watched by the associated instance.

Notes
  • This is safe to call concurrently from whatever thread.
  • This is not safe to call from within a signal handler.
  • If the signal number was already registered previously, this is a no-op.
  • If this errors, the original set of signals is left intact.
Panics
  • If the given signal is [forbidden][crate::FORBIDDEN].
  • If the signal number is negative or larger than internal limit. The limit should be larger than any supported signal the OS supports.
  • If the relevant Exfiltrator does not support this particular signal. The default [SignalOnly] one supports all signals.

Closes the associated instance.

This is meant to signalize termination of the signal delivery process. After calling close:

  • is_closed will return true.
  • All currently blocking operations of associated instances are interrupted and terminate.
  • Any further operations will not block.
  • Further signals may or may not be returned from the iterators. However, if any are returned, these are real signals that happened.

The goal is to be able to shut down any background thread that handles only the signals.

Is it closed?

See close.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.