Enum rubble::link::ad_structure::AdStructure

#[non_exhaustive]
pub enum AdStructure<'a> {
    Flags(Flags),
    ServiceUuids16(ServiceUuids<'a, Uuid16>),
    ServiceUuids32(ServiceUuids<'a, Uuid32>),
    ServiceUuids128(ServiceUuids<'a, Uuid128>),
    ServiceData16 {
        uuid: u16,
        data: &'a [u8],
    },
    CompleteLocalName(&'a str),
    ShortenedLocalName(&'a str),
    ManufacturerSpecificData {
        company_identifier: CompanyId,
        payload: &'a [u8],
    },
    Unknown {
        ty: u8,
        data: &'a [u8],
    },
}

A list of AD structures can be sent along with an advertising packet or scan response.

This mechanism allows a scanner to, for example, receive the device’s name without having to establish a connection.

Unless otherwise noted, each variant of this enum should only be included at most once per packet sent.

From a very unrepresentative scan, most devices seem to include Flags and Manufacturer Data, and optionally a device name, of course.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Flags(Flags)

Device flags and baseband capabilities.

This should be sent if any flags apply to the device. If not (ie. the value sent would be 0), this may be omitted.

Must not be used in scan response data.

Tuple Fields of Flags

0: Flags

ServiceUuids16(ServiceUuids<'a, Uuid16>)

Tuple Fields of ServiceUuids16

0: ServiceUuids<'a, Uuid16>

ServiceUuids32(ServiceUuids<'a, Uuid32>)

Tuple Fields of ServiceUuids32

0: ServiceUuids<'a, Uuid32>

ServiceUuids128(ServiceUuids<'a, Uuid128>)

Tuple Fields of ServiceUuids128

0: ServiceUuids<'a, Uuid128>

ServiceData16

Service data with 16-bit service UUID.

Fields of ServiceData16

uuid: u16

The 16-bit service UUID.

data: &'a [u8]

The associated service data. May be empty.

CompleteLocalName(&'a str)

Sets the full (unabbreviated) device name.

This will be shown to the user when this device is found.

Tuple Fields of CompleteLocalName

0: &'a str

ShortenedLocalName(&'a str)

Sets the shortened device name.

Tuple Fields of ShortenedLocalName

0: &'a str

ManufacturerSpecificData

Set manufacturer specific data

Fields of ManufacturerSpecificData

company_identifier: CompanyIdpayload: &'a [u8]

Unknown

An unknown or unimplemented AD structure stored as raw bytes.

Fields of Unknown

ty: u8

Type byte.

data: &'a [u8]

Raw data transmitted after the type.

Trait Implementations

impl<'a> Clone for AdStructure<'a>

fn clone(&self) -> AdStructure<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for AdStructure<'a>

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

Formats the value using the given formatter.

impl<'a> From<Flags> for AdStructure<'a>

fn from(flags: Flags) -> Self

Performs the conversion.

impl<'a> FromBytes<'a> for AdStructure<'a>

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<'a> ToBytes for AdStructure<'a>

fn to_bytes(&self, buf: &mut ByteWriter<'_>) -> Result<(), Error>

Lowers this AD structure into a Byte buffer.

Returns the number of Bytes of buf that are used by this AD structure.

impl<'a> Copy for AdStructure<'a>