Struct AppControlSet 

pub struct AppControlSet { /* private fields */ }

⬡ 📶 ⊆ A set of application control notices.

---

^{📍 run/app::AppControlSet}

^{📦 size_of::<AppControlSet>() == 2 bytes / 16 bits ⚗️Option<T> ❗🟰 T}

---

Implementations

impl AppControlSet

pub const fn to_linux_signals(self) -> LinuxSignalSet

Returns the Linux signals needed to receive these app controls.

impl AppControlSet

Named constants

pub const Interrupt: Self

1 The bit index that corresponds to AppControl::Interrupt.

pub const Quit: Self

1 The bit index that corresponds to AppControl::Quit.

pub const Terminate: Self

1 The bit index that corresponds to AppControl::Terminate.

pub const Hangup: Self

1 The bit index that corresponds to AppControl::Hangup.

pub const Suspend: Self

1 The bit index that corresponds to AppControl::Suspend.

pub const Resume: Self

1 The bit index that corresponds to AppControl::Resume.

pub const Close: Self

1 The bit index that corresponds to AppControl::Close.

pub const Logout: Self

1 The bit index that corresponds to AppControl::Logout.

pub const Shutdown: Self

1 The bit index that corresponds to AppControl::Shutdown.

impl AppControlSet

Convenience methods derived from each named constant.

pub const fn has_interrupt(self) -> bool

Returns true if Interrupt is present.

pub const fn contains_interrupt(self) -> bool

Returns true if all bits in Interrupt are present.

pub const fn intersects_interrupt(self) -> bool

Returns true if the set shares any bit with Interrupt.

pub const fn with_interrupt(self) -> Self

Returns self with Interrupt inserted.

pub const fn with_interrupt_if(self, condition: bool) -> Self

Returns self with Interrupt inserted if condition is true.

pub const fn without_interrupt(self) -> Self

Returns self with Interrupt removed.

pub const fn set_interrupt(&mut self)

Sets Interrupt.

pub const fn set_interrupt_if(&mut self, condition: bool)

Sets Interrupt if condition is true.

pub const fn unset_interrupt(&mut self)

Unsets Interrupt.

pub const fn has_quit(self) -> bool

Returns true if Quit is present.

pub const fn contains_quit(self) -> bool

Returns true if all bits in Quit are present.

pub const fn intersects_quit(self) -> bool

Returns true if the set shares any bit with Quit.

pub const fn with_quit(self) -> Self

Returns self with Quit inserted.

pub const fn with_quit_if(self, condition: bool) -> Self

Returns self with Quit inserted if condition is true.

pub const fn without_quit(self) -> Self

Returns self with Quit removed.

pub const fn set_quit(&mut self)

Sets Quit.

pub const fn set_quit_if(&mut self, condition: bool)

Sets Quit if condition is true.

pub const fn unset_quit(&mut self)

Unsets Quit.

pub const fn has_terminate(self) -> bool

Returns true if Terminate is present.

pub const fn contains_terminate(self) -> bool

Returns true if all bits in Terminate are present.

pub const fn intersects_terminate(self) -> bool

Returns true if the set shares any bit with Terminate.

pub const fn with_terminate(self) -> Self

Returns self with Terminate inserted.

pub const fn with_terminate_if(self, condition: bool) -> Self

Returns self with Terminate inserted if condition is true.

pub const fn without_terminate(self) -> Self

Returns self with Terminate removed.

pub const fn set_terminate(&mut self)

Sets Terminate.

pub const fn set_terminate_if(&mut self, condition: bool)

Sets Terminate if condition is true.

pub const fn unset_terminate(&mut self)

Unsets Terminate.

pub const fn has_hangup(self) -> bool

Returns true if Hangup is present.

pub const fn contains_hangup(self) -> bool

Returns true if all bits in Hangup are present.

pub const fn intersects_hangup(self) -> bool

Returns true if the set shares any bit with Hangup.

pub const fn with_hangup(self) -> Self

Returns self with Hangup inserted.

pub const fn with_hangup_if(self, condition: bool) -> Self

Returns self with Hangup inserted if condition is true.

pub const fn without_hangup(self) -> Self

Returns self with Hangup removed.

pub const fn set_hangup(&mut self)

Sets Hangup.

pub const fn set_hangup_if(&mut self, condition: bool)

Sets Hangup if condition is true.

pub const fn unset_hangup(&mut self)

Unsets Hangup.

pub const fn has_suspend(self) -> bool

Returns true if Suspend is present.

pub const fn contains_suspend(self) -> bool

Returns true if all bits in Suspend are present.

pub const fn intersects_suspend(self) -> bool

Returns true if the set shares any bit with Suspend.

pub const fn with_suspend(self) -> Self

Returns self with Suspend inserted.

pub const fn with_suspend_if(self, condition: bool) -> Self

Returns self with Suspend inserted if condition is true.

pub const fn without_suspend(self) -> Self

Returns self with Suspend removed.

pub const fn set_suspend(&mut self)

Sets Suspend.

pub const fn set_suspend_if(&mut self, condition: bool)

Sets Suspend if condition is true.

pub const fn unset_suspend(&mut self)

Unsets Suspend.

pub const fn has_resume(self) -> bool

Returns true if Resume is present.

pub const fn contains_resume(self) -> bool

Returns true if all bits in Resume are present.

pub const fn intersects_resume(self) -> bool

Returns true if the set shares any bit with Resume.

pub const fn with_resume(self) -> Self

Returns self with Resume inserted.

pub const fn with_resume_if(self, condition: bool) -> Self

Returns self with Resume inserted if condition is true.

pub const fn without_resume(self) -> Self

Returns self with Resume removed.

pub const fn set_resume(&mut self)

Sets Resume.

pub const fn set_resume_if(&mut self, condition: bool)

Sets Resume if condition is true.

pub const fn unset_resume(&mut self)

Unsets Resume.

pub const fn has_close(self) -> bool

Returns true if Close is present.

pub const fn contains_close(self) -> bool

Returns true if all bits in Close are present.

pub const fn intersects_close(self) -> bool

Returns true if the set shares any bit with Close.

pub const fn with_close(self) -> Self

Returns self with Close inserted.

pub const fn with_close_if(self, condition: bool) -> Self

Returns self with Close inserted if condition is true.

pub const fn without_close(self) -> Self

Returns self with Close removed.

pub const fn set_close(&mut self)

Sets Close.

pub const fn set_close_if(&mut self, condition: bool)

Sets Close if condition is true.

pub const fn unset_close(&mut self)

Unsets Close.

pub const fn has_logout(self) -> bool

Returns true if Logout is present.

pub const fn contains_logout(self) -> bool

Returns true if all bits in Logout are present.

pub const fn intersects_logout(self) -> bool

Returns true if the set shares any bit with Logout.

pub const fn with_logout(self) -> Self

Returns self with Logout inserted.

pub const fn with_logout_if(self, condition: bool) -> Self

Returns self with Logout inserted if condition is true.

pub const fn without_logout(self) -> Self

Returns self with Logout removed.

pub const fn set_logout(&mut self)

Sets Logout.

pub const fn set_logout_if(&mut self, condition: bool)

Sets Logout if condition is true.

pub const fn unset_logout(&mut self)

Unsets Logout.

pub const fn has_shutdown(self) -> bool

Returns true if Shutdown is present.

pub const fn contains_shutdown(self) -> bool

Returns true if all bits in Shutdown are present.

pub const fn intersects_shutdown(self) -> bool

Returns true if the set shares any bit with Shutdown.

pub const fn with_shutdown(self) -> Self

Returns self with Shutdown inserted.

pub const fn with_shutdown_if(self, condition: bool) -> Self

Returns self with Shutdown inserted if condition is true.

pub const fn without_shutdown(self) -> Self

Returns self with Shutdown removed.

pub const fn set_shutdown(&mut self)

Sets Shutdown.

pub const fn set_shutdown_if(&mut self, condition: bool)

Sets Shutdown if condition is true.

pub const fn unset_shutdown(&mut self)

Unsets Shutdown.

impl AppControlSet

Common set methods

pub const fn new() -> Self

Returns an empty set.

pub const fn from_bits(bits: u16) -> Self

Returns a set from raw bits.

pub const fn bits(self) -> u16

Returns the raw backing bits.

pub const fn all() -> Self

Returns the union of all declared sets.

pub const fn is_empty(self) -> bool

Returns true if no bits are set.

pub const fn is_full(self) -> bool

Returns true if all the declared bits are set.

pub const fn contains(self, other: Self) -> bool

Returns true if all bits in other are also set in self.

pub const fn has(self, other: Self) -> bool

An alias of contains.

pub const fn with(self, other: Self) -> Self

Returns self with other inserted.

pub const fn with_if(self, condition: bool, other: Self) -> Self

Returns self with other inserted if condition is true.

pub const fn without(self, other: Self) -> Self

Returns self with other removed.

pub const fn toggled(self, other: Self) -> Self

Returns self with other toggled.

impl AppControlSet

Set operations

pub const fn intersects(self, other: Self) -> bool

Returns true if self and other share any bit.

pub const fn is_subset(self, other: Self) -> bool

Returns true if all bits in self are also set in other.

pub const fn is_superset(self, other: Self) -> bool

Returns true if all bits in other are also set in self.

pub const fn union(self, other: Self) -> Self

Returns the union of self and other.

pub const fn intersection(self, other: Self) -> Self

Returns the intersection of self and other.

pub const fn difference(self, other: Self) -> Self

Returns the difference of self and other.

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference of self and other.

impl AppControlSet

Mutating set operations

pub const fn clear(&mut self)

Clears the set.

pub const fn insert(&mut self, other: Self)

Inserts all bits from other.

pub const fn remove(&mut self, other: Self)

Removes all bits from other.

pub const fn toggle(&mut self, other: Self)

Toggles all bits from other.

impl AppControlSet

Associated set methods

pub const fn contains_variant(self, value: &AppControl) -> bool

Returns true if the set contains the variant of value.

pub const fn has_variant(self, value: &AppControl) -> bool

An alias of contains_variant.

pub const fn with_variant(self, value: &AppControl) -> Self

Returns self with the variant of value inserted.

pub const fn without_variant(self, value: &AppControl) -> Self

Returns self with the variant of value removed.

pub const fn toggled_variant(self, value: &AppControl) -> Self

Returns self with the variant of value toggled.

pub const fn insert_variant(&mut self, value: &AppControl)

Inserts the variant of value.

pub const fn remove_variant(&mut self, value: &AppControl)

Removes the variant of value.

pub const fn toggle_variant(&mut self, value: &AppControl)

Toggles the variant of value.

pub fn for_each_set(self, f: impl FnMut(Self))

Calls f for each associated set constant present in this set.

pub fn for_each_set_while(self, f: impl FnMut(Self) -> bool) -> bool

Calls f for each associated set constant present in this set while it returns true.

Returns true if all set constants were visited, or false if iteration stopped early.

impl AppControlSet

Unit-only variant iteration

Generated only when all declared variants are unit variants.

pub fn iter(self) -> impl Iterator<Item = AppControl>

Iterates over the enum variants present in this set.

pub fn for_each(self, f: impl FnMut(AppControl))

Calls f for each variant present in this set.

pub fn for_each_while(self, f: impl FnMut(AppControl) -> bool) -> bool

Calls f for each enum variant present in this set while it returns true.

Returns true if all variants were visited, or false if iteration stopped early.

Trait Implementations

impl Binary for AppControlSet

Formats the set as a binary mask over its declared bit domain.

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

Formats the value using the given formatter.

impl BitAnd for AppControlSet

type Output = AppControlSet

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for AppControlSet

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for AppControlSet

type Output = AppControlSet

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for AppControlSet

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitSized<{ $Set::_SET_BIT_SIZE }> for AppControlSet

const BIT_SIZE: usize = _

The bit size of this type (only the relevant data part, without padding).

const MIN_BYTE_SIZE: usize = _

The rounded up byte size for this type.

fn bit_size(&self) -> usize

Returns the bit size of this type (only the relevant data part, without padding).

fn min_byte_size(&self) -> usize

Returns the rounded up byte size for this type.

impl BitXor for AppControlSet

type Output = AppControlSet

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for AppControlSet

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for AppControlSet

fn clone(&self) -> AppControlSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConstInit for AppControlSet

const INIT: Self

Returns the compile-time “initial value” for a type.

impl Copy for AppControlSet

impl Debug for AppControlSet

Formats the set as a prefixed binary mask over its declared bit domain.

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

Formats the value using the given formatter.

impl DebugExt for AppControlSet

where AppControlSet: Debug,

type Ctx = ReprMode

The context used to guide formatting.

fn fmt_with(&self, f: &mut Formatter<'_>, ctx: &Self::Ctx) -> FmtResult<()>

Formats self under the given context.

fn debug_with<'a>(&'a self, ctx: &'a Self::Ctx) -> DebugWith<'a, Self>

where Self: Sized,

Wraps self for contextual debug formatting.

impl Default for AppControlSet

fn default() -> Self

Returns the “default value” for a type.

impl Display for AppControlSet

Formats the set as a prefixed binary mask over its declared bit domain.

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

Formats the value using the given formatter.

impl Eq for AppControlSet

impl From<&AppControl> for AppControlSet

fn from(value: &AppControl) -> Self

Converts an enum value into its singleton variant set.

impl From<AppControl> for AppControlSet

fn from(value: AppControl) -> Self

Converts an enum value into its singleton variant set.

impl Hash for AppControlSet

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 LowerHex for AppControlSet

Formats the set as a hexadecimal mask over its declared bit domain.

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

Formats the value using the given formatter.

impl Not for AppControlSet

type Output = AppControlSet

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Octal for AppControlSet

Formats the set as an octal mask over its declared bit domain.

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

Formats the value using the given formatter.

impl Ord for AppControlSet

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for AppControlSet

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for AppControlSet

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub for AppControlSet

type Output = AppControlSet

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for AppControlSet

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl UpperHex for AppControlSet

Formats the set as a hexadecimal mask over its declared bit domain.

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

Formats the value using the given formatter.