Struct Settings 

pub struct Settings { /* private fields */ }

Implementations

impl Settings

pub const Powered: Self

pub const Connectable: Self

pub const FastConnectable: Self

pub const Discoverable: Self

pub const Bondable: Self

pub const LinkLevelSecurity: Self

pub const SecureSimplePairing: Self

pub const BasicRateEnhancedDataRate: Self

pub const HighSpeed: Self

pub const LowEnergy: Self

pub const Advertising: Self

pub const SecureConnections: Self

pub const DebugKeys: Self

pub const Privacy: Self

pub const ControllerConfiguration: Self

pub const StaticAddress: Self

pub const PhyConfiguration: Self

pub const WidebandSpeech: Self

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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

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

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

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

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

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.

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.

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.

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.

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

impl AsMut<Settings> for NewSettings

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetAdvertisingReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetBondableReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetBrEdrReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetConnectableReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetDebugKeysReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetDiscoverableReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetFastConnectableReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetHighSpeedReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetLinkSecurityReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetLowEnergyReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetPoweredReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetPrivacyReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetSecureConnectionsReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetSecureSimplePairingReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetStaticAddressReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsMut<Settings> for SetWidbandSpeechReply

fn as_mut(&mut self) -> &mut Settings

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<Settings> for NewSettings

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetAdvertisingReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetBondableReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetBrEdrReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetConnectableReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetDebugKeysReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetDiscoverableReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetFastConnectableReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetHighSpeedReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetLinkSecurityReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetLowEnergyReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetPoweredReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetPrivacyReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetSecureConnectionsReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetSecureSimplePairingReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetStaticAddressReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Settings> for SetWidbandSpeechReply

fn as_ref(&self) -> &Settings

Converts this type into a shared reference of the (usually inferred) input type.

impl Binary for Settings

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

Formats the value using the given formatter.

impl BitAnd for Settings

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

Returns the intersection between the two sets of flags.

type Output = Settings

The resulting type after applying the & operator.

impl BitAndAssign for Settings

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr for Settings

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

Returns the union of the two sets of flags.

type Output = Settings

The resulting type after applying the | operator.

impl BitOrAssign for Settings

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor for Settings

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

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

type Output = Settings

The resulting type after applying the ^ operator.

impl BitXorAssign for Settings

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Extend<Settings> for Settings

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

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.

impl From<Settings> for NewSettings

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetAdvertisingReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetBondableReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetBrEdrReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetConnectableReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetDebugKeysReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetDiscoverableReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetFastConnectableReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetHighSpeedReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetLinkSecurityReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetLowEnergyReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetPoweredReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetPrivacyReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetSecureConnectionsReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetSecureSimplePairingReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetStaticAddressReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl From<Settings> for SetWidbandSpeechReply

fn from(v: Settings) -> Self

Converts to this type from the input type.

impl FromIterator<Settings> for Settings

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

Creates a value from an iterator.

impl Hash for Settings

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for Settings

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

Formats the value using the given formatter.

impl Not for Settings

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = Settings

The resulting type after applying the ! operator.

impl Octal for Settings

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

Formats the value using the given formatter.

impl Ord for Settings

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl Pack for Settings

fn pack<W>(&self, write: &mut W) -> Result<()>

where W: Write,

impl PartialEq for Settings

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Settings

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub for Settings

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

Returns the set difference of the two sets of flags.

type Output = Settings

The resulting type after applying the - operator.

impl SubAssign for Settings

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl Unpack for Settings

fn unpack<R>(read: &mut R) -> Result<Self>

where R: Read,

impl UpperHex for Settings

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

Formats the value using the given formatter.

impl Copy for Settings

impl Eq for Settings

impl StructuralPartialEq for Settings