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>
impl<Payload> AsyncWebsocketClientBuilder<Payload>
sourcepub fn new() -> AsyncWebsocketClientBuilder<()>
pub fn new() -> AsyncWebsocketClientBuilder<()>
Constructs an AsyncWebsocketClientBuilder
sourcepub fn payload<NewPayload: Serialize>(
self,
payload: NewPayload
) -> AsyncWebsocketClientBuilder<NewPayload>
pub fn payload<NewPayload: Serialize>( self, payload: NewPayload ) -> AsyncWebsocketClientBuilder<NewPayload>
Add payload to connection_init
source§impl<Payload> AsyncWebsocketClientBuilder<Payload>where
Payload: Serialize,
impl<Payload> AsyncWebsocketClientBuilder<Payload>where
Payload: Serialize,
sourcepub 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,
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§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more