# tokio::signal::unix::SignalKind - Rust
API documentation for the Rust `SignalKind` struct in crate `tokio`.
Keywords: rust, rustlang, rust-lang, SignalKind

# Struct tokio::signal::unix::SignalKind [−] [src]

    pub struct SignalKind(_);

Represents the specific kind of signal to listen for.

## Implementations

### `impl SignalKind` [src]

#### `pub fn from_raw(signum: c_int) -> Self` [src]

Allows for listening to any valid OS signal.

For example, this can be used for listening for platform-specific signals.

    // let signum = libc::OS_SPECIFIC_SIGNAL;
    let kind = SignalKind::from_raw(signum);

#### `pub fn alarm() -> Self` [src]

Represents the SIGALRM signal.

On Unix systems this signal is sent when a real-time timer has expired. By default, the process is terminated by this signal.

#### `pub fn child() -> Self` [src]

Represents the SIGCHLD signal.

On Unix systems this signal is sent when the status of a child process has changed. By default, this signal is ignored.

#### `pub fn hangup() -> Self` [src]

Represents the SIGHUP signal.

On Unix systems this signal is sent when the terminal is disconnected. By default, the process is terminated by this signal.

#### `pub fn interrupt() -> Self` [src]

Represents the SIGINT signal.

On Unix systems this signal is sent to interrupt a program. By default, the process is terminated by this signal.

#### `pub fn io() -> Self` [src]

Represents the SIGIO signal.

On Unix systems this signal is sent when I/O operations are possible on some file descriptor. By default, this signal is ignored.

#### `pub fn pipe() -> Self` [src]

Represents the SIGPIPE signal.

On Unix systems this signal is sent when the process attempts to write to a pipe which has no reader. By default, the process is terminated by this signal.

#### `pub fn quit() -> Self` [src]

Represents the SIGQUIT signal.

On Unix systems this signal is sent to issue a shutdown of the process, after which the OS will dump the process core. By default, the process is terminated by this signal.

#### `pub fn terminate() -> Self` [src]

Represents the SIGTERM signal.

On Unix systems this signal is sent to issue a shutdown of the process. By default, the process is terminated by this signal.

#### `pub fn user_defined1() -> Self` [src]

Represents the SIGUSR1 signal.

On Unix systems this is a user defined signal. By default, the process is terminated by this signal.

#### `pub fn user_defined2() -> Self` [src]

Represents the SIGUSR2 signal.

On Unix systems this is a user defined signal. By default, the process is terminated by this signal.

#### `pub fn window_change() -> Self` [src]

Represents the SIGWINCH signal.

On Unix systems this signal is sent when the terminal window is resized. By default, this signal is ignored.

## Trait Implementations

### `impl Clone for SignalKind` [src]

#### `fn clone(&self) -> SignalKind` [src]

Returns a copy of the value. Read more

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

Performs copy-assignment from `source`. Read more

### `impl Copy for SignalKind` [src]

### `impl Debug for SignalKind` [src]

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl RefUnwindSafe for SignalKind` [src]

### `impl Send for SignalKind` [src]

### `impl Sync for SignalKind` [src]

### `impl Unpin for SignalKind` [src]

### `impl UnwindSafe for SignalKind` [src]

## 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ⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [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ⓘ

### Notable traits for &'_ mut F

`impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
` [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.