Struct rubble::link::FeatureSet

pub struct FeatureSet { /* fields omitted */ }

A set of optional Link Layer features.

Methods

impl FeatureSet

pub const LE_ENCRYPTION: FeatureSet

Low-Energy data encryption.

Setting this bit means that the implementation must support the following:

• The following types of LL Control PDUs: LL_ENC_REQ, LL_ENC_RSP, LL_START_ENC_REQ, LL_START_END_RSP, LL_PAUSE_ENC_REQ, LL_PAUSE_ENC_RSP.
• Encryption Start and Encryption Pause procedures.

Note that the Security Manager Protocol also needs to be implemented for this to be useful.

pub const CONN_PARAM_REQ: FeatureSet

Connection parameters request procedure.

Setting this bit means that the implementation must support the following:

• The following types of LL Control PDUs: LL_REJECT_IND_EXT, LL_CONNECTION_PARAM_REQ, LL_CONNECTION_PARAM_RSP.
• Connection Parameters Request Procedure

This is a superset of EXTENDED_REJECT_INDICATION, which may also be set when this bit is set.

pub const EXTENDED_REJECT_INDICATION: FeatureSet

Support for the LL Control PDU LL_REJECT_IND_EXT.

pub const SLAVE_FEATURE_EXCHANGE: FeatureSet

Slave-initiated feature exchange.

Setting this bit means that the implementation must support the following:

• The following types of LL Control PDUs: LL_SLAVE_FEATURE_REQ, LL_FEATURE_RSP.

TODO: What's the use of this?

pub const LE_PING: FeatureSet

Low-Energy Link-Layer ping exchange.

Setting this bit means that the implementation must support the following:

• The following types of LL Control PDUs: LL_PING_REQ, LL_PING_RSP.
• The LE Ping Procedure
• LE Authenticated Payload Timeout

If a Link-Layer is in idle state, it will transmit empty PDUs, which are never authenticated with a MIC. Supporting this feature allows configuring a timeout between authenticated packets, since dummy data can then be sent via LL_PING_REQ.

pub const LE_PACKET_LENGTH_EXTENSION: FeatureSet

Link-Layer PDU length update (support for data channel PDUs with more than 31 Bytes).

Setting this bit means that the implementation must support the following:

• The following types of LL Control PDUs: LL_LENGTH_REQ, LL_LENGTH_RSP
• The Data Length Update Procedure

pub const LL_PRIVACY: FeatureSet

Support for untrackable randomized device addresses (LL Privacy).

pub const EXT_SCANNER_FILTER_POLICIES: FeatureSet

Extended scan filter policies.

pub fn empty() -> FeatureSet

Returns an empty set of flags.

pub fn all() -> FeatureSet

Returns the set containing all flags.

pub fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

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

pub fn from_bits_truncate(bits: u64) -> FeatureSet

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

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl FeatureSet

pub fn supported() -> Self

Returns the feature set supported by Rubble.

Trait Implementations

impl ToBytes for FeatureSet

fn to_bytes(&self, writer: &mut ByteWriter) -> Result<(), Error>

Converts self to bytes and writes them into writer, advancing writer to point past the encoded value.

impl<'a> FromBytes<'a> for FeatureSet

fn from_bytes(bytes: &mut ByteReader<'a>) -> Result<Self, Error>

Decode a Self from a byte slice, advancing bytes to point past the data that was read.

impl Copy for FeatureSet

impl Debug for FeatureSet

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

Formats the value using the given formatter.

impl PartialEq<FeatureSet> for FeatureSet

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

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

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

This method tests for !=.

impl Eq for FeatureSet

impl Ord for FeatureSet

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialOrd<FeatureSet> for FeatureSet

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<FeatureSet> for FeatureSet

type Output = FeatureSet

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<FeatureSet> for FeatureSet

fn sub_assign(&mut self, other: FeatureSet)

Disables all flags enabled in the set.

impl Not for FeatureSet

type Output = FeatureSet

The resulting type after applying the ! operator.

fn not(self) -> FeatureSet

Returns the complement of this set of flags.

impl BitAnd<FeatureSet> for FeatureSet

type Output = FeatureSet

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<FeatureSet> for FeatureSet

type Output = FeatureSet

The resulting type after applying the | operator.

fn bitor(self, other: FeatureSet) -> FeatureSet

Returns the union of the two sets of flags.

impl BitXor<FeatureSet> for FeatureSet

type Output = FeatureSet

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<FeatureSet> for FeatureSet

fn bitand_assign(&mut self, other: FeatureSet)

Disables all flags disabled in the set.

impl BitOrAssign<FeatureSet> for FeatureSet

fn bitor_assign(&mut self, other: FeatureSet)

Adds the set of flags.

impl BitXorAssign<FeatureSet> for FeatureSet

fn bitxor_assign(&mut self, other: FeatureSet)

Toggles the set of flags.

impl Hash for FeatureSet

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, 

Feeds a slice of this type into the given [Hasher].

impl FromIterator<FeatureSet> for FeatureSet

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

Creates a value from an iterator.

impl Extend<FeatureSet> for FeatureSet

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

Extends a collection with the contents of an iterator.

impl Octal for FeatureSet

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

Formats the value using the given formatter.

impl Binary for FeatureSet

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

Formats the value using the given formatter.

impl LowerHex for FeatureSet

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

Formats the value using the given formatter.

impl UpperHex for FeatureSet

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

Formats the value using the given formatter.

impl Clone for FeatureSet

fn clone(&self) -> FeatureSet

Returns a copy of the value.

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

Performs copy-assignment from source.