Struct steamworks::FriendFlags
source · #[repr(C)]pub struct FriendFlags { /* private fields */ }
Implementations§
source§impl FriendFlags
impl FriendFlags
pub const NONE: Self = _
pub const BLOCKED: Self = _
pub const FRIENDSHIP_REQUESTED: Self = _
pub const IMMEDIATE: Self = _
pub const CLAN_MEMBER: Self = _
pub const ON_GAME_SERVER: Self = _
pub const REQUESTING_FRIENDSHIP: Self = _
pub const REQUESTING_INFO: Self = _
pub const IGNORED: Self = _
pub const IGNORED_FRIEND: Self = _
pub const CHAT_MEMBER: Self = _
pub const ALL: Self = _
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> 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: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> 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 FriendFlags
impl Binary for FriendFlags
source§impl BitAnd for FriendFlags
impl BitAnd for FriendFlags
source§impl BitAndAssign for FriendFlags
impl BitAndAssign for FriendFlags
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 for FriendFlags
impl BitOr for FriendFlags
source§fn bitor(self, other: FriendFlags) -> Self
fn bitor(self, other: FriendFlags) -> Self
Returns the union of the two sets of flags.
§type Output = FriendFlags
type Output = FriendFlags
|
operator.source§impl BitOrAssign for FriendFlags
impl BitOrAssign for FriendFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXor for FriendFlags
impl BitXor for FriendFlags
source§impl BitXorAssign for FriendFlags
impl BitXorAssign for FriendFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for FriendFlags
impl Clone for FriendFlags
source§fn clone(&self) -> FriendFlags
fn clone(&self) -> FriendFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for FriendFlags
impl Debug for FriendFlags
source§impl Extend<FriendFlags> for FriendFlags
impl Extend<FriendFlags> for FriendFlags
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<FriendFlags> for FriendFlags
impl FromIterator<FriendFlags> for FriendFlags
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 FriendFlags
impl Hash for FriendFlags
source§impl LowerHex for FriendFlags
impl LowerHex for FriendFlags
source§impl Not for FriendFlags
impl Not for FriendFlags
source§impl Octal for FriendFlags
impl Octal for FriendFlags
source§impl Ord for FriendFlags
impl Ord for FriendFlags
source§fn cmp(&self, other: &FriendFlags) -> Ordering
fn cmp(&self, other: &FriendFlags) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq for FriendFlags
impl PartialEq for FriendFlags
source§fn eq(&self, other: &FriendFlags) -> bool
fn eq(&self, other: &FriendFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PartialOrd for FriendFlags
impl PartialOrd for FriendFlags
source§fn partial_cmp(&self, other: &FriendFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &FriendFlags) -> 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 Sub for FriendFlags
impl Sub for FriendFlags
source§impl SubAssign for FriendFlags
impl SubAssign for FriendFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.