pub struct AsyncWebsocketClientBuilder<Payload = NoPayload> { /* private fields */ }
👎Deprecated since 0.8.0-rc.1: use ClientBuilder (via Client::build) instead
Expand description

A websocket client builder

Implementations§

source§

impl<Payload> AsyncWebsocketClientBuilder<Payload>

source

pub fn new() -> AsyncWebsocketClientBuilder<()>

Constructs an AsyncWebsocketClientBuilder

source

pub fn payload<NewPayload: Serialize>( self, payload: NewPayload ) -> AsyncWebsocketClientBuilder<NewPayload>

Add payload to connection_init

source§

impl<Payload> AsyncWebsocketClientBuilder<Payload>
where Payload: Serialize,

source

pub async fn build<WsMessage>( self, websocket_stream: impl Stream<Item = Result<WsMessage, WsMessage::Error>> + Unpin + Send + 'static, websocket_sink: impl Sink<WsMessage, Error = WsMessage::Error> + Unpin + Send + 'static, runtime: impl SpawnExt ) -> Result<AsyncWebsocketClient<WsMessage>, Error>
where WsMessage: WebsocketMessage + Send + 'static,

Constructs an AsyncWebsocketClient

Accepts a stream and a sink for the underlying websocket connection, and an async_executors::SpawnHandle that tells the client which async runtime to use.

Trait Implementations§

source§

impl<Payload> Default for AsyncWebsocketClientBuilder<Payload>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<Payload> Freeze for AsyncWebsocketClientBuilder<Payload>
where Payload: Freeze,

§

impl<Payload> RefUnwindSafe for AsyncWebsocketClientBuilder<Payload>
where Payload: RefUnwindSafe,

§

impl<Payload> Send for AsyncWebsocketClientBuilder<Payload>
where Payload: Send,

§

impl<Payload> Sync for AsyncWebsocketClientBuilder<Payload>
where Payload: Sync,

§

impl<Payload> Unpin for AsyncWebsocketClientBuilder<Payload>
where Payload: Unpin,

§

impl<Payload> UnwindSafe for AsyncWebsocketClientBuilder<Payload>
where Payload: 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<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

§

type Output = T

Should always be Self
source§

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

§

type Error = Infallible

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

§

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> IsFieldType<T> for T