Struct Ad

pub struct Ad<B: AsRef<[u8]>>(B);

Available on riot_module_bluetil_ad only.

Wrapper around bluetil_ad (BLE Advertising Data)

This is implemented as a possibly owned buffer, as that should make usage straightforward both for read-only data (not practically usable yet) and for writing; it remains to be seen whether that’s viable.

Tuple Fields

0: B

Implementations

impl<B: AsRef<[u8]>> Ad<B>

pub fn destroy(self) -> B

Reclaim the buffer that the AD was built around.

This is particularly useful when an AD object was populated, and in the end the buffer needs to be obtained in order to send it.

impl<const L: usize> Ad<Vec<u8, L>>

pub fn new() -> Self

Create an empty AD object around owned memory; the size is given by the type parameter.

fn build(&self) -> bluetil_ad_t

Construct a bluetil_ad_t that represent the current vec state

This is not unsafe in itself, but usually used with functions that are, and when they write into the buffer, it needs the unsafe heapless::Vec::set_len to propagate that write.

pub fn add_flags(&mut self, flags: u32) -> Result<(), Error>

Add a “flags” field with the given flag value to the AD (convenience function)

pub fn add(&mut self, type_: u32, data: &[u8]) -> Result<(), Error>

Add an arbitrary typed field to the AD

impl Ad<Vec<u8, 31>>

pub fn new_maximal() -> Self

Create an empty AD object around owned memory with the maximum sendable size.

This is often more convenient than new as it’s not too large anyway (31 bytes).

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.