Struct gaea::os::signals::SignalSet

pub struct SignalSet(_);

Set of Signals used in registering signal notifications with Signals.

Examples

use gaea::os::{Signal, SignalSet};

// Signal set can be created by bit-oring (`|`) signals together.
let set: SignalSet = Signal::Interrupt | Signal::Quit;
assert_eq!(set.size(), 2);

assert!(set.contains(Signal::Interrupt));
assert!(set.contains(Signal::Quit));
assert!(!set.contains(Signal::Terminate));
assert!(set.contains(Signal::Interrupt | Signal::Quit));

Methods

impl SignalSet

pub const fn empty() -> SignalSet

Create an empty signal set.

pub const fn all() -> SignalSet

Create a new set with all signals.

pub const fn size(self) -> usize

Number of signals in the set.

pub fn contains<S>(self, other: S) -> bool where
    S: Into<SignalSet>, 

Whether or not all signals in other are contained within self.

Notes

This can also be used with Signal.

Examples

use gaea::os::{Signal, SignalSet};

let set = SignalSet::all();

assert!(set.contains(Signal::Interrupt));
assert!(set.contains(Signal::Quit));
assert!(set.contains(Signal::Interrupt | Signal::Quit));

let empty = SignalSet::empty();
assert!(!empty.contains(Signal::Terminate));
assert!(!empty.contains(Signal::Terminate | Signal::Quit));

Trait Implementations

impl Eq for SignalSet

impl Ord for SignalSet

fn cmp(&self, other: &SignalSet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<SignalSet> for SignalSet

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

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

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

This method tests for !=.

impl Copy for SignalSet

impl Clone for SignalSet

fn clone(&self) -> SignalSet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<SignalSet> for SignalSet

fn partial_cmp(&self, other: &SignalSet) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &SignalSet) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &SignalSet) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &SignalSet) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &SignalSet) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl From<Signal> for SignalSet

fn from(signal: Signal) -> Self

Performs the conversion.

impl IntoIterator for SignalSet

type Item = Signal

The type of the elements being iterated over.

type IntoIter = SignalSetIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Debug for SignalSet

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

Formats the value using the given formatter.

impl BitOr<SignalSet> for SignalSet

type Output = SignalSet

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<Signal> for SignalSet

type Output = SignalSet

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<SignalSet> for Signal

type Output = SignalSet

The resulting type after applying the | operator.

fn bitor(self, rhs: SignalSet) -> SignalSet

Performs the | operation.

impl Hash for SignalSet

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, 

Feeds a slice of this type into the given [Hasher].