Skip to main content

WebSocketClientBuilder

Struct WebSocketClientBuilder 

Source
pub struct WebSocketClientBuilder<'f1, T: Handler, S: State = Empty> { /* private fields */ }
Expand description

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

Implementations§

Source§

impl<'f1, T: Handler, S: State> WebSocketClientBuilder<'f1, T, S>

Source

pub async fn build(self) -> Result<Arc<WebSocketClient<T>>>
where S: IsComplete,

Finishes building and performs the requested action.

Source

pub fn auth_token( self, value: &'f1 str, ) -> WebSocketClientBuilder<'f1, T, SetAuthToken<S>>
where S::AuthToken: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_auth_token( self, value: Option<&'f1 str>, ) -> WebSocketClientBuilder<'f1, T, SetAuthToken<S>>
where S::AuthToken: IsUnset,

Optional (Some / Option setters).

Source

pub fn server( self, value: DataServer, ) -> WebSocketClientBuilder<'f1, T, SetServer<S>>
where S::Server: IsUnset,

Optional (Some / Option setters). Default: DataServer::ProData.

Source

pub fn maybe_server( self, value: Option<DataServer>, ) -> WebSocketClientBuilder<'f1, T, SetServer<S>>
where S::Server: IsUnset,

Optional (Some / Option setters). Default: DataServer::ProData.

Source

pub fn handler(self, value: T) -> WebSocketClientBuilder<'f1, T, SetHandler<S>>
where S::Handler: IsUnset,

Required.

Source

pub fn buffer_size( self, value: usize, ) -> WebSocketClientBuilder<'f1, T, SetBufferSize<S>>
where S::BufferSize: IsUnset,

Optional (Some / Option setters). Default: 1024 * 1024.

Source

pub fn maybe_buffer_size( self, value: Option<usize>, ) -> WebSocketClientBuilder<'f1, T, SetBufferSize<S>>
where S::BufferSize: IsUnset,

Optional (Some / Option setters). Default: 1024 * 1024.

Source

pub fn error_config( self, value: ErrorRecoveryConfig, ) -> WebSocketClientBuilder<'f1, T, SetErrorConfig<S>>
where S::ErrorConfig: IsUnset,

Optional (Some / Option setters). Default: <ErrorRecoveryConfig as Default>::default().

Source

pub fn maybe_error_config( self, value: Option<ErrorRecoveryConfig>, ) -> WebSocketClientBuilder<'f1, T, SetErrorConfig<S>>
where S::ErrorConfig: IsUnset,

Optional (Some / Option setters). Default: <ErrorRecoveryConfig as Default>::default().

Auto Trait Implementations§

§

impl<'f1, T, S> Freeze for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: Freeze, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): Freeze,

§

impl<'f1, T, S> RefUnwindSafe for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: RefUnwindSafe, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): RefUnwindSafe,

§

impl<'f1, T, S> Send for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: Send, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): Send,

§

impl<'f1, T, S> Sync for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: Sync, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): Sync,

§

impl<'f1, T, S> Unpin for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: Unpin, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): Unpin,

§

impl<'f1, T, S> UnsafeUnpin for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: UnsafeUnpin, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): UnsafeUnpin,

§

impl<'f1, T, S> UnwindSafe for WebSocketClientBuilder<'f1, T, S>
where PhantomData<(fn() -> S, &'f1 (), fn() -> PhantomData<WebSocketClient<T>>, fn() -> PhantomData<T>)>: UnwindSafe, (Option<&'f1 str>, Option<DataServer>, Option<T>, Option<usize>, Option<ErrorRecoveryConfig>): UnwindSafe,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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.

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> 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, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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