Struct Identity 

#[non_exhaustive]
pub struct Identity {

    pub device_ids: Vec<String>,
    pub roles: Vec<String>,
    pub manufacturer: String,
    pub model: String,
    pub serial_number: String,
    pub ebus_version: String,
    pub device_type: Option<String>,
    pub name: Option<String>,
    pub fw_version: Option<String>,
    pub register: Option<String>,
    pub broker_ca: Option<String>,
    pub auth_methods: Vec<String>,
    pub hw_version: Option<String>,
    pub os_version: Option<String>,
    pub mac: Option<String>,
    pub extra_ebus_txt: Vec<(String, String)>,
    pub extra_device_info_txt: Vec<(String, String)>,
    pub homie_domain: Option<String>,
    pub homie_version: Option<String>,
}

Available on crate feature alloc only.

An entity’s _ebus._tcp and _device-info._tcp content (ebus.py:330-438).

One _ebus._tcp advertisement covers the whole host, so device_ids may list several devices, joined with commas into device_id. Recommended keys left empty are omitted. Extra keys never replace a key the identity sets.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

device_ids: Vec<String>

The host’s device ids; the first is the default instance name.

roles: Vec<String>

device, controller, broker-host.

manufacturer: String

Required.

model: String

Required.

serial_number: String

Required, in _device-info._tcp.

ebus_version: String

Defaults to EBUS_VERSION.

device_type: Option<String>

device_type.

name: Option<String>

name.

fw_version: Option<String>

fw_version, in both records.

register: Option<String>

register: the registration endpoint path.

broker_ca: Option<String>

broker_ca: the broker CA download path.

auth_methods: Vec<String>

auth_methods.

hw_version: Option<String>

hw_version, in _device-info._tcp.

os_version: Option<String>

os_version, in _device-info._tcp.

mac: Option<String>

mac, in _device-info._tcp.

extra_ebus_txt: Vec<(String, String)>

Keys the specification does not define, appended to _ebus._tcp.

extra_device_info_txt: Vec<(String, String)>

Keys the specification does not define, appended to _device-info._tcp.

homie_domain: Option<String>

The Homie domain the host publishes under; adds homie_domain, homie_version and homie_roles to _ebus._tcp.

homie_version: Option<String>

homie_version with homie_domain; defaults to 5.

Implementations

impl Identity

pub fn new<D, R>( device_ids: impl IntoIterator<Item = D>, roles: impl IntoIterator<Item = R>, manufacturer: &str, model: &str, serial_number: &str, ) -> Self

where D: Into<String>, R: Into<String>,

An identity with the required fields; every other field empty.

pub fn device_id(&self) -> String

The device_id value: the device ids joined with commas.

pub fn check(&self) -> Result<(), TxtError>

Check the required fields and both records (ebus.py:371-393).

pub fn ebus_txt(&self) -> TxtRecord

The _ebus._tcp record, keys in python’s order (ebus.py:400-422).

pub fn device_info_txt(&self) -> TxtRecord

The _device-info._tcp record (ebus.py:424-438).

Trait Implementations

impl Clone for Identity

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 Identity

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

Formats the value using the given formatter.

impl Eq for Identity

impl PartialEq for Identity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Identity