Struct WebSocket

pub struct WebSocket { /* private fields */ }

Available on crate feature ws only.

Implementations

impl WebSocket

pub async fn new(upgraded: Upgraded) -> Self

pub async fn receive(&mut self) -> Result<Option<Message>, Error>

Handles Ping and Pong messages

never returns Error::ConnectionClose | Error::AlreadyClosed

pub async fn send<M>(&mut self, msg: M) -> Result<(), Error>

where M: Into<Message>,

pub async fn close(&mut self, code: CloseCode, reason: String)

pub async fn ping(&mut self) -> Result<(), Error>

pub async fn deserialize<D>(&mut self) -> Result<Option<D>, JsonError>

where D: DeserializeOwned,

Available on crate feature json only.

calls receive and then deserialize

pub async fn serialize<S>(&mut self, value: &S) -> Result<(), JsonError>

where S: Serialize + ?Sized,

Available on crate feature json only.

calls serialize then send

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl<'a> Extractor<'a, WebSocket> for WebSocket

type Error = Infallible

type Prepared = ()

fn validate(_validate: Validate<'_>)

fn prepare( _prepare: Prepare<'_>, ) -> Pin<Box<dyn Future<Output = Result<Self::Prepared, Self::Error>> + Send + '_>>

fn extract( extract: Extract<'a, '_, Self::Prepared, WebSocket>, ) -> Result<Self, Self::Error>

where Self: Sized,