Struct HttpService 

#[non_exhaustive]
pub struct HttpService {
    pub tls: bool,
    pub port: u16,
    pub path: String,
    pub version: String,
    pub openapi: Option<String>,
    pub extra_txt: Vec<(String, String)>,
}

Available on crate feature alloc only.

A REST API advertised as _http._tcp or _https._tcp (ebus.py:445-477).

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.

tls: bool

_https._tcp when true.

port: u16

The API’s port.

path: String

path: the API base path.

version: String

version: the API version, 1.0 by default.

openapi: Option<String>

openapi: the OpenAPI document’s path.

extra_txt: Vec<(String, String)>

Keys the specification does not define.

Implementations

impl HttpService

pub fn http(port: u16, path: &str) -> Self

A plain HTTP API at port under path.

pub fn https(port: u16, path: &str) -> Self

An HTTPS API at port under path.

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

_https._tcp or _http._tcp.

pub fn txt(&self, identity: &Identity) -> TxtRecord

The TXT record, carrying the identity’s device_id and device_type.

Trait Implementations

impl Clone for HttpService

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 HttpService

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

Formats the value using the given formatter.

impl Eq for HttpService

impl PartialEq for HttpService

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HttpService