pub struct EventFlags { /* private fields */ }
Expand description

Event flags defined for the set_event_mask command.

Implementations§

source§

impl EventFlags

source

pub const INQUIRY_COMPLETE: Self = _

Inquiry complete event

source

pub const INQUIRY_RESULT: Self = _

Inquiry result event

source

pub const CONNECTION_COMPLETE: Self = _

Connection complete event

source

pub const CONNECTION_REQUEST: Self = _

Connection request event

source

pub const DISCONNECTION_COMPLETE: Self = _

Disconnection complete event

source

pub const AUTHENTICATION_COMPLETE: Self = _

Authentication complete event

source

pub const REMOTE_NAME_REQUEST_COMPLETE: Self = _

Remote name request complete event

source

pub const ENCRYPTION_CHANGE: Self = _

Encryption change event

Change connection link key complete event

Master link key complete event

source

pub const READ_REMOTE_SUPPORTED_FEATURES_COMPLETE: Self = _

Read remote supported features complete event

source

pub const READ_REMOTE_VERSION_INFORMATION_COMPLETE: Self = _

Read remote version information complete event

source

pub const QOS_SETUP_COMPLETE: Self = _

Qos setup complete event

source

pub const HARDWARE_ERROR: Self = _

Hardware error event

source

pub const FLUSH_OCCURRED: Self = _

Flush occurred event

source

pub const ROLE_CHANGE: Self = _

Role change event

source

pub const MODE_CHANGE: Self = _

Mode change event

Return link keys event

source

pub const PIN_CODE_REQUEST: Self = _

Pin code request event

Link key request event

Link key notification event

source

pub const LOOPBACK_COMMAND: Self = _

Loopback command event

source

pub const DATA_BUFFER_OVERFLOW: Self = _

Data buffer overflow event

source

pub const MAX_SLOTS_CHANGE: Self = _

Max slots change event

source

pub const READ_CLOCK_OFFSET_COMPLETE: Self = _

Read clock offset complete event

source

pub const CONNECTION_PACKET_TYPE_CHANGED: Self = _

Connection packet type changed event

source

pub const QOS_VIOLATION: Self = _

Qos violation event

source

pub const PAGE_SCAN_MODE_CHANGE: Self = _

👎Deprecated

Page scan mode change event. Deprecated in Bluetooth spec.

source

pub const PAGE_SCAN_REPETITION_MODE_CHANGE: Self = _

Page scan repetition mode change event

source

pub const FLOW_SPECIFICATION_COMPLETE: Self = _

Flow specification complete event

source

pub const INQUIRY_RESULT_WITH_RSSI: Self = _

Inquiry result with rssi event

source

pub const READ_REMOTE_EXTENDED_FEATURES_COMPLETE: Self = _

Read remote extended features complete event

source

pub const SYNCHRONOUS_CONNECTION_COMPLETE: Self = _

Synchronous connection complete event

source

pub const SYNCHRONOUS_CONNECTION_CHANGED: Self = _

Synchronous connection changed event

source

pub const SNIFF_SUBRATING: Self = _

Sniff subrating event

source

pub const EXTENDED_INQUIRY_RESULT: Self = _

Extended inquiry result event

source

pub const ENCRYPTION_KEY_REFRESH_COMPLETE: Self = _

Encryption key refresh complete event

source

pub const IO_CAPABILITY_REQUEST: Self = _

Io capability request event

source

pub const IO_CAPABILITY_REQUEST_REPLY: Self = _

Io capability request reply event

source

pub const USER_CONFIRMATION_REQUEST: Self = _

User confirmation request event

source

pub const USER_PASSKEY_REQUEST: Self = _

User passkey request event

source

pub const REMOTE_OOB_DATA_REQUEST: Self = _

Remote oob data request event

source

pub const SIMPLE_PAIRING_COMPLETE: Self = _

Simple pairing complete event

Link supervision timeout changed event

source

pub const ENHANCED_FLUSH_COMPLETE: Self = _

Enhanced flush complete event

source

pub const USER_PASSKEY_NOTIFICATION: Self = _

User passkey notification event

source

pub const KEYPRESS_NOTIFICATION: Self = _

Keypress notification event

source

pub const REMOTE_HOST_SUPPORTED_FEATURES_NOTIFICATION: Self = _

Remote host supported features notification event

source

pub const LE_META_EVENT: Self = _

LE meta-events

source

pub const fn empty() -> Self

Returns an empty set of flags.

source

pub const fn all() -> Self

Returns the set containing all flags.

source

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

source

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

source

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

source

pub const unsafe fn from_bits_unchecked(bits: u64) -> 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.

source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

source

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

source

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

source

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

source

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

source

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

source

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

source

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.

source

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.

source

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.

source

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.

source

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 EventFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl BitAnd<EventFlags> for EventFlags

source§

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

§

type Output = EventFlags

The resulting type after applying the & operator.
source§

impl BitAndAssign<EventFlags> for EventFlags

source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

source§

impl BitOr<EventFlags> for EventFlags

source§

fn bitor(self, other: EventFlags) -> Self

Returns the union of the two sets of flags.

§

type Output = EventFlags

The resulting type after applying the | operator.
source§

impl BitOrAssign<EventFlags> for EventFlags

source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

source§

impl BitXor<EventFlags> for EventFlags

source§

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

§

type Output = EventFlags

The resulting type after applying the ^ operator.
source§

impl BitXorAssign<EventFlags> for EventFlags

source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

source§

impl Clone for EventFlags

source§

fn clone(&self) -> EventFlags

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for EventFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for EventFlags

source§

fn default() -> EventFlags

Returns the “default value” for a type. Read more
source§

impl Extend<EventFlags> for EventFlags

source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more
source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
source§

impl Format for EventFlags

source§

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.
source§

impl FromIterator<EventFlags> for EventFlags

source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more
source§

impl Hash for EventFlags

source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl LowerHex for EventFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Not for EventFlags

source§

fn not(self) -> Self

Returns the complement of this set of flags.

§

type Output = EventFlags

The resulting type after applying the ! operator.
source§

impl Octal for EventFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Ord for EventFlags

source§

fn cmp(&self, other: &EventFlags) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

impl PartialEq<EventFlags> for EventFlags

source§

fn eq(&self, other: &EventFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialOrd<EventFlags> for EventFlags

source§

fn partial_cmp(&self, other: &EventFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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 · source§

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
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl Sub<EventFlags> for EventFlags

source§

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

§

type Output = EventFlags

The resulting type after applying the - operator.
source§

impl SubAssign<EventFlags> for EventFlags

source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

source§

impl UpperHex for EventFlags

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.
source§

impl Copy for EventFlags

source§

impl Eq for EventFlags

source§

impl StructuralEq for EventFlags

source§

impl StructuralPartialEq for EventFlags

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.