Struct nix::sys::signal::SigSet

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

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

Fields§

§sigset: sigset_t

Implementations§

source§

impl SigSet

source

pub fn all() -> SigSet

Initialize to include all signals.

source

pub fn empty() -> SigSet

Initialize to include nothing.

source

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

Add the specified signal to the set.

source

pub fn clear(&mut self)

Remove all signals from this set.

source

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

Remove the specified signal from this set.

source

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

Return whether this set includes the specified signal.

source

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

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

source

pub fn thread_get_mask() -> Result<SigSet>

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

source

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

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

source

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

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

source

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

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

source

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

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

source

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.

source

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).

source

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§

source§

impl AsRef<sigset_t> for SigSet

source§

fn as_ref(&self) -> &sigset_t

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

impl BitOr<Signal> for SigSet

§

type Output = SigSet

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl BitOr for SigSet

§

type Output = SigSet

The resulting type after applying the | operator.
source§

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

Performs the | operation. Read more
source§

impl Clone for SigSet

source§

fn clone(&self) -> SigSet

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SigSet

source§

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

Formats the value using the given formatter. Read more
source§

impl Extend<Signal> for SigSet

source§

fn extend<T>(&mut self, iter: T)
where T: IntoIterator<Item = Signal>,

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

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. Read more
source§

impl From<Signal> for SigSet

source§

fn from(signal: Signal) -> SigSet

Converts to this type from the input type.
source§

impl FromIterator<Signal> for SigSet

source§

fn from_iter<T>(iter: T) -> Self
where T: IntoIterator<Item = Signal>,

Creates a value from an iterator. Read more
source§

impl Hash for SigSet

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl PartialEq for SigSet

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Copy for SigSet

source§

impl Eq for SigSet

Auto Trait Implementations§

§

impl Freeze for SigSet

§

impl RefUnwindSafe for SigSet

§

impl Send for SigSet

§

impl Sync for SigSet

§

impl Unpin for SigSet

§

impl UnwindSafe for SigSet

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.