Skip to main content

WebSocketClient

Struct WebSocketClient 

Source
pub struct WebSocketClient<T>{ /* private fields */ }
Expand description

High-level WebSocket client with automatic reconnection, ping/pong handling, and JSON support

Implementations§

Source§

impl<T> WebSocketClient<T>

Source

pub fn new(config: WsConnectionConfig) -> Self

Create a new WebSocket client with the given configuration

Source

pub async fn connect(&self) -> Result<(WsWriter, WsReader)>

Connect to the WebSocket server without sending any subscription

Returns a writer and reader for manual message handling.

Source

pub async fn connect_stream(&self) -> Result<MessageStream<T>>

Connect to the WebSocket server and return a MessageStream

The MessageStream automatically handles PING/PONG and yields parsed messages.

Source

pub async fn connect_and_subscribe<S: Serialize>( &self, subscription: Option<&S>, ) -> Result<(WsWriter, WsReader)>

Connect and optionally send an initial subscription message

Deprecated: Use connect() + send_subscription() or connect_stream() instead.

Source

pub async fn listen<S, F>( &self, subscription: Option<S>, handler: F, ) -> Result<()>
where S: Serialize + Clone, F: FnMut(T) -> Result<()>,

Start listening to messages with automatic reconnection and ping/pong handling

Uses exponential backoff for reconnection attempts (same config as initial connection).

§Arguments
  • subscription - Optional subscription message to send on each connection
  • handler - Callback function that processes each received message
§Example
let client = WebSocketClient::<MyMessage>::new(config);
client.listen(Some(&subscription), |msg| {
    println!("Received: {:?}", msg);
    Ok(())
}).await?;

Trait Implementations§

Source§

impl<T> Clone for WebSocketClient<T>

Source§

fn clone(&self) -> WebSocketClient<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for WebSocketClient<T>

§

impl<T> RefUnwindSafe for WebSocketClient<T>
where T: RefUnwindSafe,

§

impl<T> Send for WebSocketClient<T>
where T: Send,

§

impl<T> Sync for WebSocketClient<T>
where T: Sync,

§

impl<T> Unpin for WebSocketClient<T>
where T: Unpin,

§

impl<T> UnwindSafe for WebSocketClient<T>
where T: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V