Struct EspHomeClient 

pub struct EspHomeClient { /* private fields */ }

Implementations

impl EspHomeClient

pub fn builder() -> EspHomeClientBuilder

Creates a new builder for configuring and connecting to an ESPHome API server.

pub async fn try_write<M>(&mut self, message: M) -> Result<(), ClientError>

where M: Into<EspHomeMessage> + Debug,

Sends a message to the ESPHome device.

Errors

Will return an error if the write operation fails for example due to a disconnected stream.

pub async fn try_read(&mut self) -> Result<EspHomeMessage, ClientError>

Reads the next message from the stream.

It will automatically handle ping requests if ping handling is enabled.

Errors

Will return an error if the read operation fails, for example due to a disconnected stream

pub async fn close(self) -> Result<(), ClientError>

Closes the connection gracefully by sending a DisconnectRequest message.

Errors

Will return an error if the write operation fails, for example due to a disconnected stream

pub fn write_stream(&self) -> EspHomeClientWriteStream

Returns a clone-able write stream for sending messages to the ESPHome device.

Trait Implementations

impl Debug for EspHomeClient

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

Formats the value using the given formatter.