Struct ServerWebSocket

pub struct ServerWebSocket { /* private fields */ }

Server WebSocket, used as input-output stream.

Utility type created via WebSocketAcceptorService.

[AcceptedSubProtocol] can be found in the Context, if any.

Implementations

impl ServerWebSocket

pub fn request(&self) -> &Parts

View the original request data, from which this server web socket was created.

pub fn into_inner(self) -> AsyncWebSocket

Consume self as an `AsyncWebSocket.

pub fn into_parts(self) -> (AsyncWebSocket, Parts)

Consume self into its parts.

Methods from Deref<Target = AsyncWebSocket>

pub fn get_ref(&self) -> &S

where S: Stream + Unpin,

Returns a shared reference to the inner stream.

pub fn get_mut(&mut self) -> &mut S

where S: Stream + Unpin,

Returns a mutable reference to the inner stream.

pub fn get_config(&self) -> &WebSocketConfig

Returns a reference to the configuration of the tungstenite stream.

pub async fn close( &mut self, msg: Option<CloseFrame>, ) -> Result<(), ProtocolError>

where S: Stream + Unpin,

Close the underlying web socket

pub fn send_message( &mut self, msg: Message, ) -> impl Future<Output = Result<(), ProtocolError>> + Send

Writes and immediately flushes a message.

pub async fn recv_message(&mut self) -> Result<Message, ProtocolError>

Trait Implementations

impl Debug for ServerWebSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for ServerWebSocket

type Target = AsyncWebSocket

The resulting type after dereferencing.

fn deref(&self) -> &<ServerWebSocket as Deref>::Target

Dereferences the value.

impl DerefMut for ServerWebSocket

fn deref_mut(&mut self) -> &mut <ServerWebSocket as Deref>::Target

Mutably dereferences the value.

impl Service<ServerWebSocket> for WebSocketEchoService

type Response = ()

The type of response returned by the service.

type Error = OpaqueError

The type of error returned by the service.

async fn serve( &self, ctx: Context, socket: ServerWebSocket, ) -> Result<<WebSocketEchoService as Service<ServerWebSocket>>::Response, <WebSocketEchoService as Service<ServerWebSocket>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.