Skip to main content

WebsocketConnection

Struct WebsocketConnection 

Source
pub struct WebsocketConnection { /* private fields */ }
Expand description

A WebSocket connection resource

Implementations§

Source§

impl WebsocketConnection

Source

pub fn connect( url: &str, headers: Option<&[(String, String)]>, ) -> Result<WebsocketConnection, Error>

Connect to a WebSocket server at the given URL (ws:// or wss://) Optional headers for auth, subprotocols, etc.

Source§

impl WebsocketConnection

Source

pub fn send(&self, message: &Message) -> Result<(), Error>

Send a message (text or binary)

Source§

impl WebsocketConnection

Source

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

Receive the next message (blocks until available)

Source§

impl WebsocketConnection

Source

pub fn receive_with_timeout( &self, timeout_ms: u64, ) -> Result<Option<Message>, Error>

Receive the next message with a timeout in milliseconds. Returns none if the timeout expires before a message arrives.

Source§

impl WebsocketConnection

Source

pub fn close( &self, code: Option<u16>, reason: Option<&str>, ) -> Result<(), Error>

Send a close frame with optional code and reason

Source§

impl WebsocketConnection

Source

pub fn subscribe(&self) -> Pollable

Returns a pollable that resolves when a message is available to read

Trait Implementations§

Source§

impl Debug for WebsocketConnection

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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 = 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.
Source§

impl<T> TupleOrUnit<()> for T

Source§

fn into(self)