Struct signal_hook::iterator::backend::Handle[−][src]

pub struct Handle { /* fields omitted */ }
This is supported on non-Windows and crate feature iterator only.
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

impl Handle[src]

pub fn add_signal(&self, signal: c_int) -> Result<(), Error>[src]

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.

pub fn close(&self)[src]

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.

pub fn is_closed(&self) -> bool[src]

Is it closed?

See close.

Trait Implementations

impl Clone for Handle[src]

fn clone(&self) -> Handle[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for Handle[src]

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Handle

impl Send for Handle

impl Sync for Handle

impl Unpin for Handle

impl !UnwindSafe for Handle

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

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

pub fn from(t: T) -> T[src]

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

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.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

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.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.