Struct aldrin_test::ClientBuilder

pub struct ClientBuilder { /* private fields */ }

Builder struct for a new Client.

A ClientBuilder allows for more control over how Client and Connection are setup, specifically what kind of channel is used as the transport. If you do not require any special settings, it is recommended to use TestBroker::add_client instead.

Implementations

impl ClientBuilder

pub fn new(broker: BrokerHandle) -> Self

Creates a new ClientBuilder.

The default ClientBuilder is configured to use an unbounded channel between Broker and Client.

pub async fn build(self) -> TestClient

Creates a new TestClient with the current settings.

pub fn unbounded_channel(self) -> Self

Uses an unbounded channel as the transport between Broker and Client.

This is the default after creating a new ClientBuilder.

pub fn bounded_channel(self, fifo_size: usize) -> Self

Uses a bounded channel as the transport between Broker and Client.

See aldrin_core::channel::bounded for more information on the fifo_size parameter.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.