Struct nix::sys::signal::SigSet

#[repr(transparent)]
pub struct SigSet {
    sigset: sigset_t,
}

Specifies a set of Signals that may be blocked, waited for, etc.

Fields

sigset: sigset_t

Implementations

impl SigSet

pub fn all() -> SigSet

Initialize to include all signals.

pub fn empty() -> SigSet

Initialize to include nothing.

pub fn add(&mut self, signal: Signal)

Add the specified signal to the set.

pub fn clear(&mut self)

Remove all signals from this set.

pub fn remove(&mut self, signal: Signal)

Remove the specified signal from this set.

pub fn contains(&self, signal: Signal) -> bool

Return whether this set includes the specified signal.

pub fn iter(&self) -> SigSetIter<'_>

Returns an iterator that yields the signals contained in this set.

pub fn thread_get_mask() -> Result<SigSet>

Gets the currently blocked (masked) set of signals for the calling thread.

pub fn thread_set_mask(&self) -> Result<()>

Sets the set of signals as the signal mask for the calling thread.

pub fn thread_block(&self) -> Result<()>

Adds the set of signals to the signal mask for the calling thread.

pub fn thread_unblock(&self) -> Result<()>

Removes the set of signals from the signal mask for the calling thread.

pub fn thread_swap_mask(&self, how: SigmaskHow) -> Result<SigSet>

Sets the set of signals as the signal mask, and returns the old mask.

pub fn wait(&self) -> Result<Signal>

Suspends execution of the calling thread until one of the signals in the signal mask becomes pending, and returns the accepted signal.

pub fn suspend(&self) -> Result<()>

Wait for a signal

Return value

If sigsuspend(2) is interrupted (EINTR), this function returns Ok. If sigsuspend(2) set other error, this function returns Err.

For more information see the sigsuspend(2).

pub unsafe fn from_sigset_t_unchecked(sigset: sigset_t) -> SigSet

Converts a libc::sigset_t object to a SigSet without checking whether the libc::sigset_t is already initialized.

Safety

The sigset passed in must be a valid an initialized libc::sigset_t by calling either sigemptyset(3) or sigfillset(3). Otherwise, the results are undefined.

Trait Implementations

impl AsRef<sigset_t> for SigSet

fn as_ref(&self) -> &sigset_t

Converts this type into a shared reference of the (usually inferred) input type.

impl BitOr<Signal> for SigSet

type Output = SigSet

The resulting type after applying the | operator.

fn bitor(self, rhs: Signal) -> Self::Output

Performs the | operation.

impl BitOr for SigSet

type Output = SigSet

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for SigSet

fn clone(&self) -> SigSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigSet

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

Formats the value using the given formatter.

impl Extend<Signal> for SigSet

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Signal>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl From<Signal> for SigSet

fn from(signal: Signal) -> SigSet

Converts to this type from the input type.

impl FromIterator<Signal> for SigSet

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Signal>,

Creates a value from an iterator.

impl Hash for SigSet

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> IntoIterator for &'a SigSet

type Item = Signal

The type of the elements being iterated over.

type IntoIter = SigSetIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for SigSet

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SigSet

impl Eq for SigSet