WebSocketContext

Struct WebSocketContext 

Source
pub struct WebSocketContext<'ctx> { /* private fields */ }
Expand description

example.rs

use mews::{WebSocketContext, Connection, Message};
 
async fn handle_websocket(
    headers: Headers/* of upgrade request */,
    tcp: TcpStream
) -> Response {
    let ctx = WebSocketContext::new(
        &headers["Sec-WebSocket-Key"]
    );
 
    let (sign, ws) = ctx.on_upgrade(
        |mut conn: Connection<TcpStream>| async move {
            while let Ok(Some(Message::Text(text))) = conn.recv().await {
                conn.send(text).await
                    .expect("failed to send message");
                sleep(Duration::from_secs(1)).await;
            }
        }
    );
 
    spawn(ws.manage(tcp));
 
    /* return `Switching Protocol` response with `sign`... */
}

Implementations§

Source§

impl<'ctx> WebSocketContext<'ctx>

Source

pub fn new(sec_websocket_key: &'ctx str) -> Self

create WebSocketContext with Sec-WebSocket-Key request header value.

Source

pub fn with(self, config: Config) -> Self

Source

pub fn on_upgrade<C: UnderlyingConnection, H, F>( self, handler: H, ) -> (String, WebSocket<C>)
where H: FnOnce(Connection<C>) -> F + Send + Sync + 'static, F: Future<Output = ()> + Send + 'static,

create Sec-WebSocket-Accept value and a WebSocket with the handler.

§handler

any ’static FnOnce(Connection<C>) -> {impl Future<Output = ()> + Send} + Send + Sync

Trait Implementations§

Source§

impl Debug for WebSocketContext<'_>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WebSocketContext<'_>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl<'ctx> Freeze for WebSocketContext<'ctx>

§

impl<'ctx> RefUnwindSafe for WebSocketContext<'ctx>

§

impl<'ctx> Send for WebSocketContext<'ctx>

§

impl<'ctx> Sync for WebSocketContext<'ctx>

§

impl<'ctx> Unpin for WebSocketContext<'ctx>

§

impl<'ctx> UnwindSafe for WebSocketContext<'ctx>

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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.