Struct sse::BroadcastFlags
source · pub struct BroadcastFlags { /* private fields */ }
Implementations
sourceimpl BroadcastFlags
impl BroadcastFlags
pub const NO_LOG: Self = _
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u8) -> Self
pub const unsafe fn from_bits_unchecked(bits: u8) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for BroadcastFlags
impl Binary for BroadcastFlags
sourceimpl BitAnd<BroadcastFlags> for BroadcastFlags
impl BitAnd<BroadcastFlags> for BroadcastFlags
type Output = BroadcastFlags
type Output = BroadcastFlags
&
operator.sourceimpl BitAndAssign<BroadcastFlags> for BroadcastFlags
impl BitAndAssign<BroadcastFlags> for BroadcastFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<BroadcastFlags> for BroadcastFlags
impl BitOr<BroadcastFlags> for BroadcastFlags
sourcefn bitor(self, other: BroadcastFlags) -> Self
fn bitor(self, other: BroadcastFlags) -> Self
Returns the union of the two sets of flags.
type Output = BroadcastFlags
type Output = BroadcastFlags
|
operator.sourceimpl BitOrAssign<BroadcastFlags> for BroadcastFlags
impl BitOrAssign<BroadcastFlags> for BroadcastFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<BroadcastFlags> for BroadcastFlags
impl BitXor<BroadcastFlags> for BroadcastFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = BroadcastFlags
type Output = BroadcastFlags
^
operator.sourceimpl BitXorAssign<BroadcastFlags> for BroadcastFlags
impl BitXorAssign<BroadcastFlags> for BroadcastFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for BroadcastFlags
impl Clone for BroadcastFlags
sourcefn clone(&self) -> BroadcastFlags
fn clone(&self) -> BroadcastFlags
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for BroadcastFlags
impl Debug for BroadcastFlags
sourceimpl Extend<BroadcastFlags> for BroadcastFlags
impl Extend<BroadcastFlags> for BroadcastFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)sourceimpl FromIterator<BroadcastFlags> for BroadcastFlags
impl FromIterator<BroadcastFlags> for BroadcastFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
sourceimpl Hash for BroadcastFlags
impl Hash for BroadcastFlags
sourceimpl LowerHex for BroadcastFlags
impl LowerHex for BroadcastFlags
sourceimpl Not for BroadcastFlags
impl Not for BroadcastFlags
type Output = BroadcastFlags
type Output = BroadcastFlags
!
operator.sourceimpl Octal for BroadcastFlags
impl Octal for BroadcastFlags
sourceimpl Ord for BroadcastFlags
impl Ord for BroadcastFlags
sourcefn cmp(&self, other: &BroadcastFlags) -> Ordering
fn cmp(&self, other: &BroadcastFlags) -> Ordering
1.21.0 · sourcefn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
1.21.0 · sourcefn min(self, other: Self) -> Selfwhere
Self: Sized,
fn min(self, other: Self) -> Selfwhere
Self: Sized,
1.50.0 · sourcefn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
fn clamp(self, min: Self, max: Self) -> Selfwhere
Self: Sized + PartialOrd<Self>,
sourceimpl PartialEq<BroadcastFlags> for BroadcastFlags
impl PartialEq<BroadcastFlags> for BroadcastFlags
sourcefn eq(&self, other: &BroadcastFlags) -> bool
fn eq(&self, other: &BroadcastFlags) -> bool
sourceimpl PartialOrd<BroadcastFlags> for BroadcastFlags
impl PartialOrd<BroadcastFlags> for BroadcastFlags
sourcefn partial_cmp(&self, other: &BroadcastFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &BroadcastFlags) -> Option<Ordering>
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresourceimpl Sub<BroadcastFlags> for BroadcastFlags
impl Sub<BroadcastFlags> for BroadcastFlags
type Output = BroadcastFlags
type Output = BroadcastFlags
-
operator.sourceimpl SubAssign<BroadcastFlags> for BroadcastFlags
impl SubAssign<BroadcastFlags> for BroadcastFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for BroadcastFlags
impl UpperHex for BroadcastFlags
impl Copy for BroadcastFlags
impl Eq for BroadcastFlags
impl StructuralEq for BroadcastFlags
impl StructuralPartialEq for BroadcastFlags
Auto Trait Implementations
impl RefUnwindSafe for BroadcastFlags
impl Send for BroadcastFlags
impl Sync for BroadcastFlags
impl Unpin for BroadcastFlags
impl UnwindSafe for BroadcastFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.