Struct WebSocket 

pub struct WebSocket { /* private fields */ }

Represents a WebSocket connection initiated by a page.

WebSocket objects are created by the Playwright server when the page opens a WebSocket connection. Use crate::protocol::Page::on_websocket to receive WebSocket objects.

See: https://playwright.dev/docs/api/class-websocket

Implementations

impl WebSocket

pub fn new( parent: Arc<dyn ChannelOwner>, type_name: String, guid: Arc<str>, initializer: Value, ) -> Result<Self>

Creates a new WebSocket object.

pub fn url(&self) -> &str

Returns the URL of the WebSocket connection.

See: https://playwright.dev/docs/api/class-websocket#web-socket-url

pub fn is_closed(&self) -> bool

Returns true if the WebSocket is closed.

The value becomes true when the "close" event fires (i.e. when the underlying TCP connection is torn down). It remains false from construction until that point.

See: https://playwright.dev/docs/api/class-websocket#web-socket-is-closed

pub async fn on_frame_sent<F>(&self, handler: F) -> Result<()>

where F: Fn(String) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Registers a handler that fires when a frame is sent from the page to the server.

The handler receives the frame payload as a String. For binary frames the value is the base-64-encoded representation.

Errors

Returns an error only if the handler cannot be registered (in practice this never fails).

See: https://playwright.dev/docs/api/class-websocket#web-socket-event-frame-sent

pub async fn on_frame_received<F>(&self, handler: F) -> Result<()>

where F: Fn(String) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Registers a handler that fires when a frame is received from the server.

The handler receives the frame payload as a String. For binary frames the value is the base-64-encoded representation.

Errors

Returns an error only if the handler cannot be registered (in practice this never fails).

See: https://playwright.dev/docs/api/class-websocket#web-socket-event-frame-received

pub async fn on_error<F>(&self, handler: F) -> Result<()>

where F: Fn(String) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Registers a handler that fires when the WebSocket encounters an error.

The handler receives the error message as a String.

See: https://playwright.dev/docs/api/class-websocket#web-socket-event-socket-error

pub async fn on_close<F>(&self, handler: F) -> Result<()>

where F: Fn(()) -> Pin<Box<dyn Future<Output = Result<()>> + Send>> + Send + Sync + 'static,

Registers a handler that fires when the WebSocket is closed.

See: https://playwright.dev/docs/api/class-websocket#web-socket-event-close

pub async fn expect_close( &self, timeout: Option<f64>, ) -> Result<EventWaiter<()>>

Creates a one-shot waiter that resolves when the WebSocket is closed.

The waiter must be created before the action that closes the WebSocket to avoid a race condition.

Arguments

• timeout — Timeout in milliseconds. Defaults to 30 000 ms if None.

Errors

Returns Error::Timeout if the WebSocket is not closed within the timeout.

See: https://playwright.dev/docs/api/class-websocket#web-socket-wait-for-event

pub async fn expect_frame_received( &self, timeout: Option<f64>, ) -> Result<EventWaiter<String>>

Creates a one-shot waiter that resolves when the next frame is received from the server.

The waiter must be created before the action that causes a frame to be received to avoid a race condition.

Arguments

• timeout — Timeout in milliseconds. Defaults to 30 000 ms if None.

Errors

Returns Error::Timeout if no frame is received within the timeout.

See: https://playwright.dev/docs/api/class-websocket#web-socket-wait-for-event

pub async fn expect_frame_sent( &self, timeout: Option<f64>, ) -> Result<EventWaiter<String>>

Creates a one-shot waiter that resolves when the next frame is sent from the page.

The waiter must be created before the action that sends the frame to avoid a race condition.

Arguments

• timeout — Timeout in milliseconds. Defaults to 30 000 ms if None.

Errors

Returns Error::Timeout if no frame is sent within the timeout.

See: https://playwright.dev/docs/api/class-websocket#web-socket-wait-for-event

Trait Implementations

impl Clone for WebSocket

fn clone(&self) -> WebSocket

Returns a duplicate of the value.

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

Performs copy-assignment from source.