Struct Signals Copy item path

pub const fn empty() -> Signals

Get a flags value with all bits unset.

pub const fn all() -> Signals

Get a flags value with all known bits set.

pub const fn bits(&self) -> u32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u32) -> Option<Signals>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u32) -> Signals

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u32) -> Signals

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Signals>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

Whether any set bits in a source flags value are also set in a target flags value.

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

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Signals)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Signals)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Signals)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Signals, value: bool)

Call insert when value is true or remove when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

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

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Signals

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl Signals

pub const fn iter(&self) -> Iter<Signals>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<Signals>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations§

impl Binary for Signals

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

Formats the value using the given formatter. Read more

impl BitAnd for Signals

fn bitand(self, other: Signals) -> Signals

The bitwise and (&) of the bits in two flags values.

type Output = Signals

The resulting type after applying the & operator.

impl BitAndAssign for Signals

fn bitand_assign(&mut self, other: Signals)

The bitwise and (&) of the bits in two flags values.

impl BitOr for Signals

fn bitor(self, other: Signals) -> Signals

The bitwise or (|) of the bits in two flags values.

type Output = Signals

The resulting type after applying the | operator.

impl BitOrAssign for Signals

fn bitor_assign(&mut self, other: Signals)

The bitwise or (|) of the bits in two flags values.

impl BitXor for Signals

fn bitxor(self, other: Signals) -> Signals

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = Signals

The resulting type after applying the ^ operator.

impl BitXorAssign for Signals

fn bitxor_assign(&mut self, other: Signals)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for Signals

fn clone(&self) -> Signals

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

impl Debug for Signals

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

Formats the value using the given formatter. Read more

impl Extend<Signals> for Signals

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

The bitwise or (|) of the bits in each flags value.

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

impl Flags for Signals

const FLAGS: &'static [Flag<Signals>]

The set of defined flags.

type Bits = u32

The underlying bits type.

fn bits(&self) -> u32

Get the underlying bits value. Read more

fn from_bits_retain(bits: u32) -> Signals

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value. Read more

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set. Read more

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values. Read more

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values. Read more

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

fn intersects(&self, other: Self) -> bool
where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

fn contains(&self, other: Self) -> bool
where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)
where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)
where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)
where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!). Read more

fn toggle(&mut self, other: Self)
where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)
where Self: Sized,

Call [Flags::insert] when value is true or [Flags::remove] when value is false.

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

The bitwise and (&) of the bits in two flags values.

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

The bitwise or (|) of the bits in two flags values.

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

The intersection of a source flags value with the complement of a target flags value (&!). Read more

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

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<Signals> for Signals

fn from_iter<T>(iterator: T) -> Signals
where T: IntoIterator<Item = Signals>,

The bitwise or (|) of the bits in each flags value.

impl Hash for Signals

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

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

impl IntoIterator for Signals

type Item = Signals

The type of the elements being iterated over.

type IntoIter = Iter<Signals>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <Signals as IntoIterator>::IntoIter

Creates an iterator from a value. Read more

impl LowerHex for Signals

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

Formats the value using the given formatter. Read more

impl Not for Signals

fn not(self) -> Signals

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = Signals

The resulting type after applying the ! operator.

impl Octal for Signals

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

Formats the value using the given formatter. Read more

impl Ord for Signals

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

This method returns an Ordering between self and other. Read more

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

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

Restrict a value to a certain interval. Read more

impl PartialEq for Signals

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

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

1.0.0 · Source§

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 PartialOrd for Signals

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

1.0.0 · Source§

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

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

impl Sub for Signals

fn sub(self, other: Signals) -> Signals

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = Signals

The resulting type after applying the - operator.

impl SubAssign for Signals

fn sub_assign(&mut self, other: Signals)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for Signals

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

Formats the value using the given formatter. Read more

impl Copy for Signals

impl Eq for Signals

impl StructuralPartialEq for Signals

Auto Trait Implementations§

impl Freeze for Signals

impl RefUnwindSafe for Signals

impl Send for Signals

impl Sync for Signals

impl Unpin for Signals

impl UnwindSafe for Signals

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.