Struct bluez_async::CharacteristicFlags
source · [−]pub struct CharacteristicFlags { /* private fields */ }
Expand description
The set of flags (a.k.a. properties) of a characteristic, defining how the characteristic can be used.
Implementations
sourceimpl CharacteristicFlags
impl CharacteristicFlags
pub const BROADCAST: Self = Self{bits: 1,}
pub const READ: Self = Self{bits: 2,}
pub const WRITE_WITHOUT_RESPONSE: Self = Self{bits: 4,}
pub const WRITE: Self = Self{bits: 8,}
pub const NOTIFY: Self = Self{bits: 16,}
pub const INDICATE: Self = Self{bits: 32,}
pub const SIGNED_WRITE: Self = Self{bits: 64,}
pub const EXTENDED_PROPERTIES: Self = Self{bits: 128,}
pub const RELIABLE_WRITE: Self = Self{bits: 256,}
pub const WRITABLE_AUXILIARIES: Self = Self{bits: 512,}
pub const ENCRYPT_READ: Self = Self{bits: 1024,}
pub const ENCRYPT_WRITE: Self = Self{bits: 2048,}
pub const ENCRYPT_AUTHENTICATED_READ: Self = Self{bits: 4096,}
pub const ENCRYPT_AUTHENTICATED_WRITE: Self = Self{bits: 8192,}
pub const AUTHORIZE: Self = Self{bits: 16384,}
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
sourceimpl Binary for CharacteristicFlags
impl Binary for CharacteristicFlags
sourceimpl BitAnd<CharacteristicFlags> for CharacteristicFlags
impl BitAnd<CharacteristicFlags> for CharacteristicFlags
type Output = CharacteristicFlags
type Output = CharacteristicFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<CharacteristicFlags> for CharacteristicFlags
impl BitAndAssign<CharacteristicFlags> for CharacteristicFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<CharacteristicFlags> for CharacteristicFlags
impl BitOr<CharacteristicFlags> for CharacteristicFlags
sourcefn 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
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<CharacteristicFlags> for CharacteristicFlags
impl BitOrAssign<CharacteristicFlags> for CharacteristicFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<CharacteristicFlags> for CharacteristicFlags
impl BitXor<CharacteristicFlags> for CharacteristicFlags
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 = CharacteristicFlags
type Output = CharacteristicFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<CharacteristicFlags> for CharacteristicFlags
impl BitXorAssign<CharacteristicFlags> for CharacteristicFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for CharacteristicFlags
impl Clone for CharacteristicFlags
sourcefn clone(&self) -> CharacteristicFlags
fn clone(&self) -> CharacteristicFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for CharacteristicFlags
impl Debug for CharacteristicFlags
sourceimpl Extend<CharacteristicFlags> for CharacteristicFlags
impl Extend<CharacteristicFlags> for CharacteristicFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<CharacteristicFlags> for CharacteristicFlags
impl FromIterator<CharacteristicFlags> for CharacteristicFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for CharacteristicFlags
impl Hash for CharacteristicFlags
sourceimpl LowerHex for CharacteristicFlags
impl LowerHex for CharacteristicFlags
sourceimpl Not for CharacteristicFlags
impl Not for CharacteristicFlags
type Output = CharacteristicFlags
type Output = CharacteristicFlags
The resulting type after applying the !
operator.
sourceimpl Octal for CharacteristicFlags
impl Octal for CharacteristicFlags
sourceimpl Ord for CharacteristicFlags
impl Ord for CharacteristicFlags
sourceimpl PartialEq<CharacteristicFlags> for CharacteristicFlags
impl PartialEq<CharacteristicFlags> for CharacteristicFlags
sourcefn eq(&self, other: &CharacteristicFlags) -> bool
fn eq(&self, other: &CharacteristicFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CharacteristicFlags) -> bool
fn ne(&self, other: &CharacteristicFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<CharacteristicFlags> for CharacteristicFlags
impl PartialOrd<CharacteristicFlags> for CharacteristicFlags
sourcefn partial_cmp(&self, other: &CharacteristicFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &CharacteristicFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<CharacteristicFlags> for CharacteristicFlags
impl Sub<CharacteristicFlags> for CharacteristicFlags
type Output = CharacteristicFlags
type Output = CharacteristicFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<CharacteristicFlags> for CharacteristicFlags
impl SubAssign<CharacteristicFlags> for CharacteristicFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl TryFrom<Vec<String, Global>> for CharacteristicFlags
impl TryFrom<Vec<String, Global>> for CharacteristicFlags
type Error = BluetoothError
type Error = BluetoothError
The type returned in the event of a conversion error.
sourceimpl UpperHex for CharacteristicFlags
impl UpperHex for CharacteristicFlags
impl Copy for CharacteristicFlags
impl Eq for CharacteristicFlags
impl StructuralEq for CharacteristicFlags
impl StructuralPartialEq for CharacteristicFlags
Auto Trait Implementations
impl RefUnwindSafe for CharacteristicFlags
impl Send for CharacteristicFlags
impl Sync for CharacteristicFlags
impl Unpin for CharacteristicFlags
impl UnwindSafe for CharacteristicFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more