Skip to main content

WsSession

Struct WsSession 

Source
pub struct WsSession {
    pub url: String,
    pub protocol: WsProtocol,
    pub domain: String,
    /* private fields */
}
Expand description

An active WebSocket session.

Wraps a tokio-tungstenite connection with session metadata (cookies, auth tokens, protocol details).

Fields§

§url: String

The WebSocket URL this session is connected to.

§protocol: WsProtocol

The protocol used (Raw, Socket.IO, SockJS, SignalR).

§domain: String

Domain of the connected site.

Implementations§

Source§

impl WsSession

Source

pub async fn connect( endpoint: &WsEndpoint, cookies: &HashMap<String, String>, ) -> Result<Self>

Connect to a WebSocket endpoint.

Builds the connection URL and optional headers (cookies, auth tokens), then opens the WebSocket connection.

Source

pub async fn send_json<T: Serialize>(&mut self, msg: &T) -> Result<()>

Send a JSON-serializable message over the WebSocket.

For Socket.IO, wraps the message in the appropriate frame format. For raw WebSocket, sends as-is.

Source

pub async fn receive(&mut self) -> Result<Option<String>>

Receive the next message from the WebSocket.

Returns None if the connection is closed. Automatically skips ping/pong control frames and returns the next data message.

Source

pub async fn watch(&mut self, duration_ms: u64) -> Result<Vec<WsMessage>>

Receive messages for a given duration, returning all collected messages.

Source

pub async fn close(&mut self) -> Result<()>

Close the WebSocket connection gracefully.

Source

pub fn is_connected(&self) -> bool

Whether the connection is currently open.

Source

pub fn history(&self) -> &[WsMessage]

Get the message history.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,