Struct fire_http::ws::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: ?Sized>(&mut self, value: &S) -> Result<(), JsonError>where
    S: Serialize,

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.