Skip to main content

ClientBuilder

Struct ClientBuilder 

Source
pub struct ClientBuilder { /* private fields */ }
Available on crate feature blocking only.
Expand description

Builder of the blocking Client; the options of crate::ClientBuilder.

Implementations§

Source§

impl ClientBuilder

Source

pub fn new(address: impl Into<String>) -> Self

A builder for address (see crate::ClientBuilder::new). Starts the runtime thread.

§Panics

When the OS refuses to start a thread.

Source

pub fn namespace(self, namespace: impl Into<String>) -> Self

Source

pub fn path(self, path: impl Into<String>) -> Self

Source

pub fn query(self, key: impl Into<String>, value: impl Into<String>) -> Self

Source

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Source

pub fn auth(self, auth: impl Into<Value>) -> Self

Source

pub fn transport_type(self, transport: TransportType) -> Self

Source

pub fn timeout(self, timeout: Duration) -> Self

Source

pub fn reconnection(self, reconnection: bool) -> Self

Source

pub fn reconnection_attempts(self, attempts: u32) -> Self

Source

pub fn reconnection_delay(self, delay: Duration) -> Self

Source

pub fn reconnection_delay_max(self, delay: Duration) -> Self

Source

pub fn randomization_factor(self, factor: f64) -> Self

Source

pub fn reconnect_on_disconnect(self, reconnect: bool) -> Self

Source

pub fn buffer_while_disconnected(self, buffer: bool) -> Self

Source

pub fn redact_query(self, redact: bool) -> Self

Source

pub fn tls_config(self, tls_config: impl Into<TlsConfig>) -> Self

Available on crate features native-tls or rustls only.
Source

pub fn auth_with<F>(self, auth: F) -> Self
where F: Fn() -> Value + Send + Sync + 'static,

See crate::ClientBuilder::auth_with; auth runs on a blocking thread.

Source

pub fn inspect_packets<F>(self, inspector: F) -> Self
where F: Fn(Direction, &Packet) + Send + Sync + 'static,

Source

pub fn on<F>(self, event: impl Into<String>, handler: F) -> Self
where F: Fn(Event, Client) + Send + Sync + 'static,

Handles event (on a blocking thread, in arrival order).

Source

pub fn once<F>(self, event: impl Into<String>, handler: F) -> Self
where F: Fn(Event, Client) + Send + Sync + 'static,

Handles the next event only.

Source

pub fn on_any<F>(self, handler: F) -> Self
where F: Fn(Event, Client) + Send + Sync + 'static,

Handles every event.

Source

pub fn on_state_change<F>(self, handler: F) -> Self
where F: Fn(ConnectionState, Client) + Send + Sync + 'static,

Sees every state transition.

Source

pub fn connect(self) -> Result<Client>

Connects (see crate::ClientBuilder::connect), blocking until CONNECT or failure.

Trait Implementations§

Source§

impl Debug for ClientBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more