Enum BeaconFrame 

pub enum BeaconFrame {
    IBeacon {
        uuid: [u8; 16],
        major: u16,
        minor: u16,
        measured_power: i8,
    },
    EddystoneUid {
        namespace: [u8; 10],
        instance: [u8; 6],
        tx_power: i8,
    },
    EddystoneUrl {
        url: String,
        scheme: u8,
        encoded: Vec<u8>,
        tx_power: i8,
    },
}

A beacon advertisement, described by the fields a model can actually produce.

Constructed from structured action parameters (a UUID string, integers, a URL) — never from a blob of bytes. The byte layout is this module’s job, not the model’s.

Variants

IBeacon

Apple iBeacon: proximity UUID, major, minor, and the RSSI measured at 1 m.

Fields

uuid: [u8; 16]

128-bit proximity UUID.

major: u16

Major value (big-endian on the wire).

minor: u16

Minor value (big-endian on the wire).

measured_power: i8

Calibrated RSSI at 1 m, in dBm.

EddystoneUid

Eddystone-UID: a 10-byte namespace and a 6-byte instance.

Fields

namespace: [u8; 10]

10-byte namespace id.

instance: [u8; 6]

6-byte instance id.

tx_power: i8

Calibrated TX power at 0 m, in dBm.

EddystoneUrl

Eddystone-URL: a compressed http(s) URL.

Fields

url: String

The URL as supplied, kept for logging and equality.

scheme: u8

Scheme prefix code (0x00-0x03).

encoded: Vec<u8>

The encoded body, already validated to fit.

tx_power: i8

Calibrated TX power at 0 m, in dBm.

Implementations

impl BeaconFrame

pub fn ibeacon( uuid: &str, major: i64, minor: i64, measured_power: i64, ) -> Result<Self, PayloadError>

Build an iBeacon frame from structured fields.

pub fn eddystone_uid( namespace: &str, instance: &str, tx_power: i64, ) -> Result<Self, PayloadError>

Build an Eddystone-UID frame from structured fields.

namespace accepts the canonical 20 hex digits, or a full 128-bit UUID whose first 10 bytes are taken (the spec’s “truncated UUID” derivation). instance accepts 12 hex digits. Both are identifiers in their published textual form, not opaque payload bytes — the beacon’s actual payload is built here, from these.

pub fn eddystone_url(url: &str, tx_power: i64) -> Result<Self, PayloadError>

Build an Eddystone-URL frame, failing if the URL cannot be encoded or does not fit.

pub fn kind(&self) -> &'static str

Short human-readable identity, for status lines and logs.

pub fn manufacturer_data(&self) -> Option<(u16, Vec<u8>)>

The ManufacturerData entry BlueZ needs, as (company_id, bytes).

Only iBeacon uses manufacturer data; Eddystone frames return None.

pub fn service_data(&self) -> Option<(u16, Vec<u8>)>

The ServiceData entry BlueZ needs, as (uuid16, bytes).

Only Eddystone frames use service data; iBeacon returns None.

pub fn service_uuids16(&self) -> Vec<u16>

The 16-bit service UUIDs that must appear in the advertisement.

Eddystone requires 0xFEAA in the “complete list of 16-bit service UUIDs” alongside its service data; iBeacon advertises none.

pub fn advertising_data(&self) -> Vec<u8>

The complete AD payload a scanner observes, excluding any local name.

Not sent anywhere: BlueZ composes the real packet from Self::manufacturer_data, Self::service_data and Self::service_uuids16. This exists to make the published layouts assertable and to size the local-name budget.

pub fn local_name_budget(&self) -> usize

How many octets of device name still fit in the 31-octet payload, if any.

A local-name AD structure costs two octets of overhead on top of the name, so a budget below one means the name has to be dropped. iBeacon leaves exactly one spare octet and therefore never carries a name — which is correct rather than a limitation: an iBeacon advertisement is defined as manufacturer data and nothing else. Returning the budget instead of silently overflowing is what keeps BlueZ from refusing to register the advertisement at all.

pub fn fit_local_name<'a>(&self, name: &'a str) -> Option<&'a str>

The device name to advertise, truncated to fit, or None when there is no room.

Truncation is on a char boundary: a byte-index cut through multi-byte UTF-8 panics, and this name arrives from LLM or MCP input.

pub fn advertising_data_with_name(&self, name: &str) -> Vec<u8>

The AD payload including the local name that fits, for verification and logging.

pub fn describe(&self) -> String

One-line description for status output and the access log.

Trait Implementations

impl Clone for BeaconFrame

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeaconFrame

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

Formats the value using the given formatter.

impl Eq for BeaconFrame

impl PartialEq for BeaconFrame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BeaconFrame