Struct WebSocketRoute 

pub struct WebSocketRoute { /* private fields */ }

Represents an intercepted WebSocket connection.

WebSocketRoute is passed to handlers registered via crate::protocol::Page::route_web_socket or crate::protocol::BrowserContext::route_web_socket. The handler must call connect_to_server to forward the connection to the real server, or close to terminate it.

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

Implementations

impl WebSocketRoute

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

Creates a new WebSocketRoute object.

pub fn url(&self) -> &str

Returns the URL of the intercepted WebSocket connection.

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

pub async fn connect_to_server(&self) -> Result<()>

Connects this WebSocket to the actual server.

After calling this method, all messages sent by the page are forwarded to the server, and all messages sent by the server are forwarded to the page.

Errors

Returns an error if the RPC call fails.

See: https://playwright.dev/docs/api/class-websocketroute#web-socket-route-connect-to-server

pub async fn close( &self, options: Option<WebSocketRouteCloseOptions>, ) -> Result<()>

Closes the WebSocket connection.

Arguments

• options — Optional close code and reason.

See: https://playwright.dev/docs/api/class-websocketroute#web-socket-route-close

pub async fn send(&self, message: &str) -> Result<()>

Sends a text message to the page.

Arguments

• message — The text message to send.

See: https://playwright.dev/docs/api/class-websocketroute#web-socket-route-send

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

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

Registers a handler for messages sent from the page.

Arguments

• handler — Async closure that receives the message payload as a String.

See: https://playwright.dev/docs/api/class-websocketroute#web-socket-route-on-message

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 for when the WebSocket is closed by the page.

See: https://playwright.dev/docs/api/class-websocketroute#web-socket-route-on-close

Trait Implementations

impl Clone for WebSocketRoute

fn clone(&self) -> WebSocketRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.