Skip to main content

SocketClientBuilder

Struct SocketClientBuilder 

Source
pub struct SocketClientBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with connect().

Implementations§

Source§

impl<S: State> SocketClientBuilder<S>

Source

pub async fn connect(self) -> Result<SocketClient>
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn config(self, value: SocketConfig) -> SocketClientBuilder<SetConfig<S>>
where S::Config: IsUnset,

Required.

Source

pub fn post_reconnection( self, value: Arc<dyn Fn() + Send + Sync>, ) -> SocketClientBuilder<SetPostReconnection<S>>
where S::PostReconnection: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_post_reconnection( self, value: Option<Arc<dyn Fn() + Send + Sync>>, ) -> SocketClientBuilder<SetPostReconnection<S>>
where S::PostReconnection: IsUnset,

Optional (Some / Option setters).

Source

pub fn state_sink( self, value: SocketStateSink, ) -> SocketClientBuilder<SetStateSink<S>>
where S::StateSink: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_state_sink( self, value: Option<SocketStateSink>, ) -> SocketClientBuilder<SetStateSink<S>>
where S::StateSink: IsUnset,

Optional (Some / Option setters).

Source

pub fn reconnect_replay( self, value: SocketReconnectReplay, ) -> SocketClientBuilder<SetReconnectReplay<S>>
where S::ReconnectReplay: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_reconnect_replay( self, value: Option<SocketReconnectReplay>, ) -> SocketClientBuilder<SetReconnectReplay<S>>
where S::ReconnectReplay: IsUnset,

Optional (Some / Option setters).

Auto Trait Implementations§

§

impl<S = Empty> !RefUnwindSafe for SocketClientBuilder<S>

§

impl<S = Empty> !UnwindSafe for SocketClientBuilder<S>

§

impl<S> Freeze for SocketClientBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<SocketClient>)>: Freeze,

§

impl<S> Send for SocketClientBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<SocketClient>)>: Send,

§

impl<S> Sync for SocketClientBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<SocketClient>)>: Sync,

§

impl<S> Unpin for SocketClientBuilder<S>
where PhantomData<(fn() -> S, fn() -> PhantomData<SocketClient>)>: Unpin,

§

impl<S> UnsafeUnpin for SocketClientBuilder<S>

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

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
§

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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, <T as TryFrom<U>>::Error>

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.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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