Skip to main content

WebSocket

Struct WebSocket 

Source
pub struct WebSocket<'w> { /* private fields */ }
Expand description

The connection, inside a WebSocketHandler callback.

Implementations§

Source§

impl WebSocket<'_>

Source

pub fn send_text(&mut self, text: &str)

Sends a text message.

Source

pub fn send_binary(&mut self, data: &[u8])

Sends a binary message.

Source

pub fn ping(&mut self, data: &[u8])

Sends a ping (at most 125 bytes).

Source

pub fn close(&mut self, code: u16, reason: &str)

Starts the closing handshake with code (for example 1000) and reason.

Source

pub fn is_closing(&self) -> bool

True once a close was sent.

Source

pub fn handle(&self) -> WsHandle

A handle to send from other threads.

Trait Implementations§

Source§

impl Debug for WebSocket<'_>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'w> !RefUnwindSafe for WebSocket<'w>

§

impl<'w> !UnwindSafe for WebSocket<'w>

§

impl<'w> Forget for WebSocket<'w>

§

impl<'w> Freeze for WebSocket<'w>

§

impl<'w> Move for WebSocket<'w>

§

impl<'w> Send for WebSocket<'w>

§

impl<'w> Sync for WebSocket<'w>

§

impl<'w> Unpin for WebSocket<'w>

§

impl<'w> UnsafeUnpin for WebSocket<'w>

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.