Struct quakeworld::protocol::types::UserCommandFlags
source · pub struct UserCommandFlags { /* private fields */ }
Implementations§
source§impl UserCommandFlags
impl UserCommandFlags
pub const ANGLE1: Self = _
pub const ANGLE3: Self = _
pub const FORWARD: Self = _
pub const SIDE: Self = _
pub const UP: Self = _
pub const BUTTONS: Self = _
pub const IMPULSE: Self = _
pub const ANGLE2: 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§
source§impl Binary for UserCommandFlags
impl Binary for UserCommandFlags
source§impl BitAnd<UserCommandFlags> for UserCommandFlags
impl BitAnd<UserCommandFlags> for UserCommandFlags
source§impl BitAndAssign<UserCommandFlags> for UserCommandFlags
impl BitAndAssign<UserCommandFlags> for UserCommandFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<UserCommandFlags> for UserCommandFlags
impl BitOr<UserCommandFlags> for UserCommandFlags
source§fn bitor(self, other: UserCommandFlags) -> Self
fn bitor(self, other: UserCommandFlags) -> Self
Returns the union of the two sets of flags.
§type Output = UserCommandFlags
type Output = UserCommandFlags
|
operator.source§impl BitOrAssign<UserCommandFlags> for UserCommandFlags
impl BitOrAssign<UserCommandFlags> for UserCommandFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor<UserCommandFlags> for UserCommandFlags
impl BitXor<UserCommandFlags> for UserCommandFlags
source§impl BitXorAssign<UserCommandFlags> for UserCommandFlags
impl BitXorAssign<UserCommandFlags> for UserCommandFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for UserCommandFlags
impl Clone for UserCommandFlags
source§fn clone(&self) -> UserCommandFlags
fn clone(&self) -> UserCommandFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UserCommandFlags
impl Debug for UserCommandFlags
source§impl Default for UserCommandFlags
impl Default for UserCommandFlags
source§fn default() -> UserCommandFlags
fn default() -> UserCommandFlags
source§impl Extend<UserCommandFlags> for UserCommandFlags
impl Extend<UserCommandFlags> for UserCommandFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<UserCommandFlags> for UserCommandFlags
impl FromIterator<UserCommandFlags> for UserCommandFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for UserCommandFlags
impl Hash for UserCommandFlags
source§impl LowerHex for UserCommandFlags
impl LowerHex for UserCommandFlags
source§impl Not for UserCommandFlags
impl Not for UserCommandFlags
source§impl Octal for UserCommandFlags
impl Octal for UserCommandFlags
source§impl Ord for UserCommandFlags
impl Ord for UserCommandFlags
source§fn cmp(&self, other: &UserCommandFlags) -> Ordering
fn cmp(&self, other: &UserCommandFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<UserCommandFlags> for UserCommandFlags
impl PartialEq<UserCommandFlags> for UserCommandFlags
source§fn eq(&self, other: &UserCommandFlags) -> bool
fn eq(&self, other: &UserCommandFlags) -> bool
source§impl PartialOrd<UserCommandFlags> for UserCommandFlags
impl PartialOrd<UserCommandFlags> for UserCommandFlags
source§fn partial_cmp(&self, other: &UserCommandFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &UserCommandFlags) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Serialize for UserCommandFlags
impl Serialize for UserCommandFlags
source§impl Sub<UserCommandFlags> for UserCommandFlags
impl Sub<UserCommandFlags> for UserCommandFlags
source§impl SubAssign<UserCommandFlags> for UserCommandFlags
impl SubAssign<UserCommandFlags> for UserCommandFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.