Struct bluez_async::CharacteristicFlags
source · pub struct CharacteristicFlags(_);
Expand description
The set of flags (a.k.a. properties) of a characteristic, defining how the characteristic can be used.
Implementations§
source§impl CharacteristicFlags
impl CharacteristicFlags
pub const BROADCAST: Self = _
pub const READ: Self = _
pub const WRITE_WITHOUT_RESPONSE: Self = _
pub const WRITE: Self = _
pub const NOTIFY: Self = _
pub const INDICATE: Self = _
pub const SIGNED_WRITE: Self = _
pub const EXTENDED_PROPERTIES: Self = _
pub const RELIABLE_WRITE: Self = _
pub const WRITABLE_AUXILIARIES: Self = _
pub const ENCRYPT_READ: Self = _
pub const ENCRYPT_WRITE: Self = _
pub const ENCRYPT_AUTHENTICATED_READ: Self = _
pub const ENCRYPT_AUTHENTICATED_WRITE: Self = _
pub const AUTHORIZE: Self = _
source§impl CharacteristicFlags
impl CharacteristicFlags
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 fn from_bits_retain(bits: u16) -> Self
pub const fn from_bits_retain(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get the value for a flag from its stringified name.
Names are case-sensitive, so must correspond exactly to the identifier given to the flag.
sourcepub const fn iter_names(&self) -> IterRaw
pub const fn iter_names(&self) -> IterRaw
Iterate over enabled flag values with their stringified names.
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 CharacteristicFlags
impl Binary for CharacteristicFlags
source§impl BitAndAssign<CharacteristicFlags> for CharacteristicFlags
impl BitAndAssign<CharacteristicFlags> for CharacteristicFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitFlags for CharacteristicFlags
impl BitFlags for CharacteristicFlags
§type IterNames = IterRaw
type IterNames = IterRaw
source§fn from_bits(bits: u16) -> Option<CharacteristicFlags>
fn from_bits(bits: u16) -> Option<CharacteristicFlags>
source§fn from_bits_truncate(bits: u16) -> CharacteristicFlags
fn from_bits_truncate(bits: u16) -> CharacteristicFlags
source§fn from_bits_retain(bits: u16) -> CharacteristicFlags
fn from_bits_retain(bits: u16) -> CharacteristicFlags
source§fn iter_names(&self) -> Self::IterNames
fn iter_names(&self) -> Self::IterNames
source§fn intersects(&self, other: CharacteristicFlags) -> bool
fn intersects(&self, other: CharacteristicFlags) -> bool
true
if there are flags common to both self
and other
.source§fn contains(&self, other: CharacteristicFlags) -> bool
fn contains(&self, other: CharacteristicFlags) -> bool
true
if all of the flags in other
are contained within self
.source§fn insert(&mut self, other: CharacteristicFlags)
fn insert(&mut self, other: CharacteristicFlags)
source§fn remove(&mut self, other: CharacteristicFlags)
fn remove(&mut self, other: CharacteristicFlags)
source§fn toggle(&mut self, other: CharacteristicFlags)
fn toggle(&mut self, other: CharacteristicFlags)
source§fn set(&mut self, other: CharacteristicFlags, value: bool)
fn set(&mut self, other: CharacteristicFlags, value: bool)
source§impl BitOr<CharacteristicFlags> for CharacteristicFlags
impl BitOr<CharacteristicFlags> for CharacteristicFlags
source§fn bitor(self, other: CharacteristicFlags) -> Self
fn bitor(self, other: CharacteristicFlags) -> Self
Returns the union of the two sets of flags.
§type Output = CharacteristicFlags
type Output = CharacteristicFlags
|
operator.source§impl BitOrAssign<CharacteristicFlags> for CharacteristicFlags
impl BitOrAssign<CharacteristicFlags> for CharacteristicFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<CharacteristicFlags> for CharacteristicFlags
impl BitXorAssign<CharacteristicFlags> for CharacteristicFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for CharacteristicFlags
impl Clone for CharacteristicFlags
source§fn clone(&self) -> CharacteristicFlags
fn clone(&self) -> CharacteristicFlags
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CharacteristicFlags
impl Debug for CharacteristicFlags
source§impl Extend<CharacteristicFlags> for CharacteristicFlags
impl Extend<CharacteristicFlags> for CharacteristicFlags
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<CharacteristicFlags> for CharacteristicFlags
impl FromIterator<CharacteristicFlags> for CharacteristicFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl IntoIterator for CharacteristicFlags
impl IntoIterator for CharacteristicFlags
source§impl LowerHex for CharacteristicFlags
impl LowerHex for CharacteristicFlags
source§impl Not for CharacteristicFlags
impl Not for CharacteristicFlags
source§impl Octal for CharacteristicFlags
impl Octal for CharacteristicFlags
source§impl PartialEq<CharacteristicFlags> for CharacteristicFlags
impl PartialEq<CharacteristicFlags> for CharacteristicFlags
source§fn eq(&self, other: &CharacteristicFlags) -> bool
fn eq(&self, other: &CharacteristicFlags) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for CharacteristicFlags
impl PublicFlags for CharacteristicFlags
source§impl Sub<CharacteristicFlags> for CharacteristicFlags
impl Sub<CharacteristicFlags> for CharacteristicFlags
source§impl SubAssign<CharacteristicFlags> for CharacteristicFlags
impl SubAssign<CharacteristicFlags> for CharacteristicFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.