Struct BrokerEndpoint 

#[non_exhaustive]
pub struct BrokerEndpoint {
    pub broker_type: BrokerType,
    pub host: String,
    pub port: u16,
    pub server: Option<String>,
    pub device_id: Option<String>,
    pub addrs: Vec<ScopedAddr>,
    pub instance: Option<String>,
}

Available on crate feature alloc only.

A broker to connect to, discovered or configured.

Built with from_instance, configured or from_url.

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.

broker_type: BrokerType

The transport.

host: String

The TXT broker value, else the SRV target, without a trailing dot (ebus.py:599-614); the configured URL’s host for a configured broker.

port: u16

The port.

server: Option<String>

The SRV target, without a trailing dot.

device_id: Option<String>

The TXT device_id value, as advertised.

addrs: Vec<ScopedAddr>

The advertised addresses worth trying, in candidate order (candidate_addresses).

instance: Option<String>

The instance name; None for a configured broker.

Implementations

impl BrokerEndpoint

pub fn from_instance(instance: &Instance) -> Option<Self>

The endpoint a browsed broker instance gives (ebus.py:598-614): host is the TXT broker value, trimmed and with one trailing dot removed, else the SRV target; port 0 becomes the type’s default port. None for an instance that is not a broker type.

pub fn from_url(url: &str) -> Result<Self, UrlError>

A configured broker from an mqtt:// or mqtts:// URL (ebus.py:616-633): the port defaults to 1883 or 8883, and the host is lowercased, as python’s urlsplit gives it, except an IPv6 zone.

pub fn configured(broker_type: BrokerType, host: &str, port: u16) -> Self

A configured broker of broker_type at host and port.

pub fn url(&self) -> String

scheme://host:port, with an IPv6 host in brackets (ebus.py:592-596).

pub fn connect_host(&self) -> Cow<'_, str>

The host to connect to: host when it is not a .local name, else the first IPv4 candidate address, else host, for TLS and plain transports alike.

pub fn device_ids(&self) -> Vec<String>

The TXT device_id items.

Trait Implementations

impl Clone for BrokerEndpoint

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 BrokerEndpoint

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

Formats the value using the given formatter.

impl Eq for BrokerEndpoint

impl Hash for BrokerEndpoint

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BrokerEndpoint

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BrokerEndpoint