Skip to main content

WebSocketClientBuilder

nautilus_network::websocket::client

Struct WebSocketClientBuilder 

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

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

Implementations§

Source§

impl<S: State> WebSocketClientBuilder<S>

Source

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

Finishes building and performs the requested action.

Source

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

Required.

Source

pub fn message_handler( self, value: MessageHandler, ) -> WebSocketClientBuilder<SetMessageHandler<S>>
where S::MessageHandler: IsUnset,

Required.

Source

pub fn ping_handler( self, value: PingHandler, ) -> WebSocketClientBuilder<SetPingHandler<S>>
where S::PingHandler: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_ping_handler( self, value: Option<PingHandler>, ) -> WebSocketClientBuilder<SetPingHandler<S>>
where S::PingHandler: IsUnset,

Optional (Some / Option setters).

Source

pub fn keyed_quotas( self, value: Vec<(String, Quota)>, ) -> WebSocketClientBuilder<SetKeyedQuotas<S>>
where S::KeyedQuotas: IsUnset,

Optional (Some / Option setters). Default: <Vec<(String, Quota)> as Default>::default().

Source

pub fn maybe_keyed_quotas( self, value: Option<Vec<(String, Quota)>>, ) -> WebSocketClientBuilder<SetKeyedQuotas<S>>
where S::KeyedQuotas: IsUnset,

Optional (Some / Option setters). Default: <Vec<(String, Quota)> as Default>::default().

Source

pub fn default_quota( self, value: Quota, ) -> WebSocketClientBuilder<SetDefaultQuota<S>>
where S::DefaultQuota: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_default_quota( self, value: Option<Quota>, ) -> WebSocketClientBuilder<SetDefaultQuota<S>>
where S::DefaultQuota: IsUnset,

Optional (Some / Option setters).

Source

pub fn rate_limiter( self, value: Arc<RateLimiter<Ustr, MonotonicClock>>, ) -> WebSocketClientBuilder<SetRateLimiter<S>>
where S::RateLimiter: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_rate_limiter( self, value: Option<Arc<RateLimiter<Ustr, MonotonicClock>>>, ) -> WebSocketClientBuilder<SetRateLimiter<S>>
where S::RateLimiter: IsUnset,

Optional (Some / Option setters).

Source

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

Optional (Some / Option setters).

Source

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

Optional (Some / Option setters).

Source

pub fn connection_rate_limiter( self, value: Arc<RateLimiter<Ustr, MonotonicClock>>, ) -> WebSocketClientBuilder<SetConnectionRateLimiter<S>>
where S::ConnectionRateLimiter: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_connection_rate_limiter( self, value: Option<Arc<RateLimiter<Ustr, MonotonicClock>>>, ) -> WebSocketClientBuilder<SetConnectionRateLimiter<S>>
where S::ConnectionRateLimiter: IsUnset,

Optional (Some / Option setters).

Source

pub fn connection_rate_keys( self, value: Arc<[Ustr]>, ) -> WebSocketClientBuilder<SetConnectionRateKeys<S>>
where S::ConnectionRateKeys: IsUnset,

Optional (Some / Option setters). Default: <Arc<[Ustr]> as Default>::default().

Source

pub fn maybe_connection_rate_keys( self, value: Option<Arc<[Ustr]>>, ) -> WebSocketClientBuilder<SetConnectionRateKeys<S>>
where S::ConnectionRateKeys: IsUnset,

Optional (Some / Option setters). Default: <Arc<[Ustr]> as Default>::default().

Source

pub fn initial_connect_retry_policy( self, value: InitialConnectRetryPolicy, ) -> WebSocketClientBuilder<SetInitialConnectRetryPolicy<S>>
where S::InitialConnectRetryPolicy: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_initial_connect_retry_policy( self, value: Option<InitialConnectRetryPolicy>, ) -> WebSocketClientBuilder<SetInitialConnectRetryPolicy<S>>
where S::InitialConnectRetryPolicy: IsUnset,

Optional (Some / Option setters).

Source

pub fn cancellation_token( self, value: CancellationToken, ) -> WebSocketClientBuilder<SetCancellationToken<S>>
where S::CancellationToken: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_cancellation_token( self, value: Option<CancellationToken>, ) -> WebSocketClientBuilder<SetCancellationToken<S>>
where S::CancellationToken: IsUnset,

Optional (Some / Option setters).

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
§

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