Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder for synchronous MQTT clients.

The request channel is bounded by default using MqttOptions::request_channel_capacity. Use Self::capacity to override the bounded capacity, or Self::unbounded to opt into an unbounded request channel.

Implementations

impl ClientBuilder

pub const fn new(options: MqttOptions) -> ClientBuilder

Create a new builder for a synchronous Client.

pub const fn capacity(self, cap: usize) -> ClientBuilder

Use a bounded request channel with the given capacity.

0 creates a bounded zero-capacity rendezvous channel. Use Self::unbounded for an unbounded request channel.

pub const fn unbounded(self) -> ClientBuilder

Use an unbounded request channel.

pub fn build(self) -> (Client, Connection)

Build a synchronous client and connection.

This builder always produces the synchronous client pair so the terminal build() method matches the entry point that created it.

Panics

Panics if the current-thread Tokio runtime cannot be created.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.