pub struct SignalKind(/* private fields */);Expand description
Represents the specific kind of signal to listen for.
Implementations§
Source§impl SignalKind
impl SignalKind
Sourcepub const fn from_raw(signum: i32) -> SignalKind
pub const fn from_raw(signum: i32) -> SignalKind
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);Sourcepub const fn as_raw_value(&self) -> i32
pub const fn as_raw_value(&self) -> i32
Get the signal’s numeric value.
let kind = SignalKind::interrupt();
assert_eq!(kind.as_raw_value(), libc::SIGINT);Sourcepub const fn alarm() -> SignalKind
pub const fn alarm() -> SignalKind
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.
Sourcepub const fn child() -> SignalKind
pub const fn child() -> SignalKind
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.
Sourcepub const fn hangup() -> SignalKind
pub const fn hangup() -> SignalKind
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.
Sourcepub const fn interrupt() -> SignalKind
pub const fn interrupt() -> SignalKind
Represents the SIGINT signal.
On Unix systems this signal is sent to interrupt a program. By default, the process is terminated by this signal.
Sourcepub const fn io() -> SignalKind
pub const fn io() -> SignalKind
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.
Sourcepub const fn pipe() -> SignalKind
pub const fn pipe() -> SignalKind
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.
Sourcepub const fn quit() -> SignalKind
pub const fn quit() -> SignalKind
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.
Sourcepub const fn terminate() -> SignalKind
pub const fn terminate() -> SignalKind
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.
Sourcepub const fn user_defined1() -> SignalKind
pub const fn user_defined1() -> SignalKind
Represents the SIGUSR1 signal.
On Unix systems this is a user defined signal. By default, the process is terminated by this signal.
Sourcepub const fn user_defined2() -> SignalKind
pub const fn user_defined2() -> SignalKind
Represents the SIGUSR2 signal.
On Unix systems this is a user defined signal. By default, the process is terminated by this signal.
Sourcepub const fn window_change() -> SignalKind
pub const fn window_change() -> SignalKind
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§
Source§impl Clone for SignalKind
impl Clone for SignalKind
Source§fn clone(&self) -> SignalKind
fn clone(&self) -> SignalKind
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for SignalKind
impl Debug for SignalKind
Source§impl From<i32> for SignalKind
impl From<i32> for SignalKind
Source§fn from(signum: i32) -> SignalKind
fn from(signum: i32) -> SignalKind
Source§impl Hash for SignalKind
impl Hash for SignalKind
Source§impl PartialEq for SignalKind
impl PartialEq for SignalKind
impl Copy for SignalKind
impl Eq for SignalKind
impl StructuralPartialEq for SignalKind
Auto Trait Implementations§
impl Freeze for SignalKind
impl RefUnwindSafe for SignalKind
impl Send for SignalKind
impl Sync for SignalKind
impl Unpin for SignalKind
impl UnwindSafe for SignalKind
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);