Struct ServerWebSocket 

pub struct ServerWebSocket<S = AsyncWebSocket> {
    pub socket: S,
    pub request: Parts,
}

Available on crate features http and std and ws only.

Server WebSocket, used as input-output stream.

Utility type created via WebSocketAcceptorService.

AcceptedWebSocketProtocol can be found in the extensions, if any.

Fields

socket: S

Established WebSocket message transport.

request: Parts

Original HTTP handshake request metadata.

Implementations

impl<S> ServerWebSocket<S>

pub fn map_socket<T>(self, map: impl FnOnce(S) -> T) -> ServerWebSocket<T>

Transform the message transport while preserving handshake metadata.

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

where S: Sink<Message, Error = ProtocolError> + Send + Unpin,

Write and flush one message.

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

where S: Stream<Item = Result<Message, ProtocolError>> + Unpin,

Receive one complete message.

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

where S: Sink<Message, Error = ProtocolError> + Send + Unpin,

Start the close handshake by sending a Close frame.

The handshake completes once the peer’s Close is read: keep receiving until the stream ends. Dropping the socket before that aborts the connection.

pub fn request(&self) -> &Parts

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

pub fn into_inner(self) -> S

Consume self and return its message transport.

Trait Implementations

impl<S> Debug for ServerWebSocket<S>

where S: Debug,

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

Formats the value using the given formatter.

impl<S> Deref for ServerWebSocket<S>

type Target = S

The resulting type after dereferencing.

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

Dereferences the value.

impl<S> DerefMut for ServerWebSocket<S>

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

Mutably dereferences the value.

impl<S> ExtensionsRef for ServerWebSocket<S>

where S: ExtensionsRef,

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl<S> Service<ServerWebSocket<S>> for WebSocketEchoService

where S: WebSocketIo,

type Output = ()

The type of the output returned by the service.

type Error = Box<dyn Error + Sync + Send>

The type of error returned by the service.

async fn serve( &self, socket: ServerWebSocket<S>, ) -> Result<<WebSocketEchoService as Service<ServerWebSocket<S>>>::Output, <WebSocketEchoService as Service<ServerWebSocket<S>>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl<Inner, Socket> Service<ServerWebSocket<Socket>> for HARWebSocketService<Inner>

where Inner: Service<ServerWebSocket<HARWebSocket<Socket>>>, Socket: WebSocketIo,

type Output = <Inner as Service<ServerWebSocket<HARWebSocket<Socket>>>>::Output

The type of the output returned by the service.

type Error = <Inner as Service<ServerWebSocket<HARWebSocket<Socket>>>>::Error

The type of error returned by the service.

async fn serve( &self, websocket: ServerWebSocket<Socket>, ) -> Result<<HARWebSocketService<Inner> as Service<ServerWebSocket<Socket>>>::Output, <HARWebSocketService<Inner> as Service<ServerWebSocket<Socket>>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl<S> Sink<Message> for ServerWebSocket<S>

where S: Sink<Message, Error = ProtocolError> + Unpin,

type Error = ProtocolError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut ServerWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <ServerWebSocket<S> as Sink<Message>>::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut ServerWebSocket<S>>, message: Message, ) -> Result<(), <ServerWebSocket<S> as Sink<Message>>::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut ServerWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <ServerWebSocket<S> as Sink<Message>>::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut ServerWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Result<(), <ServerWebSocket<S> as Sink<Message>>::Error>>

Flush any remaining output and close this sink, if necessary.

impl<S> Stream for ServerWebSocket<S>

where S: Stream<Item = Result<Message, ProtocolError>> + Unpin,

type Item = Result<Message, ProtocolError>

Values yielded by the stream.

fn poll_next( self: Pin<&mut ServerWebSocket<S>>, ctx: &mut Context<'_>, ) -> Poll<Option<<ServerWebSocket<S> as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.