browser-commander 0.17.0

// @generated by scripts/generate-playwright-protocol.mjs from
// rust/protocol/playwright/*.yml. Do not edit by hand.

#![allow(clippy::all, missing_docs, unused_imports)]

use serde::{Deserialize, Serialize};

use super::*;
use crate::playwright::connection::{
    Binary, Channel, ChannelType, ObjectRef, ProtocolError, ProtocolEvent, Ref,
};

/// Initializer the driver sends when it creates a `WebSocketRoute`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteInitializer {
    #[serde(rename = "url")]
    pub url: String,
    #[serde(rename = "protocols")]
    pub protocols: Vec<String>,
}

/// Parameters of `WebSocketRoute.sendToPage` (Send WebSocket message).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteSendToPageParams {
    #[serde(rename = "message")]
    pub message: String,
    #[serde(rename = "isBase64")]
    pub is_base64: bool,
}

/// Parameters of `WebSocketRoute.sendToServer` (Send WebSocket message).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteSendToServerParams {
    #[serde(rename = "message")]
    pub message: String,
    #[serde(rename = "isBase64")]
    pub is_base64: bool,
}

/// Parameters of `WebSocketRoute.closePage`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteClosePageParams {
    #[serde(rename = "code", default, skip_serializing_if = "Option::is_none")]
    pub code: Option<i64>,
    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[serde(rename = "wasClean")]
    pub was_clean: bool,
}

/// Parameters of `WebSocketRoute.closeServer`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteCloseServerParams {
    #[serde(rename = "code", default, skip_serializing_if = "Option::is_none")]
    pub code: Option<i64>,
    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[serde(rename = "wasClean")]
    pub was_clean: bool,
}

/// Payload of the `WebSocketRoute.messageFromPage` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteMessageFromPageEventParams {
    #[serde(rename = "message")]
    pub message: String,
    #[serde(rename = "isBase64")]
    pub is_base64: bool,
}

/// Payload of the `WebSocketRoute.messageFromServer` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteMessageFromServerEventParams {
    #[serde(rename = "message")]
    pub message: String,
    #[serde(rename = "isBase64")]
    pub is_base64: bool,
}

/// Payload of the `WebSocketRoute.closePage` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteClosePageEventParams {
    #[serde(rename = "code", default, skip_serializing_if = "Option::is_none")]
    pub code: Option<i64>,
    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[serde(rename = "wasClean")]
    pub was_clean: bool,
}

/// Payload of the `WebSocketRoute.closeServer` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct WebSocketRouteCloseServerEventParams {
    #[serde(rename = "code", default, skip_serializing_if = "Option::is_none")]
    pub code: Option<i64>,
    #[serde(rename = "reason", default, skip_serializing_if = "Option::is_none")]
    pub reason: Option<String>,
    #[serde(rename = "wasClean")]
    pub was_clean: bool,
}

/// Events a `WebSocketRoute` channel can emit.
#[derive(Debug, Clone, PartialEq)]
pub enum WebSocketRouteEvent {
    /// `WebSocketRoute.messageFromPage`
    MessageFromPage(WebSocketRouteMessageFromPageEventParams),
    /// `WebSocketRoute.messageFromServer`
    MessageFromServer(WebSocketRouteMessageFromServerEventParams),
    /// `WebSocketRoute.closePage`
    ClosePage(WebSocketRouteClosePageEventParams),
    /// `WebSocketRoute.closeServer`
    CloseServer(WebSocketRouteCloseServerEventParams),
    /// An event this binding does not know (a newer driver).
    Unknown {
        /// Event name.
        method: String,
        /// Raw event parameters.
        params: serde_json::Value,
    },
}

impl ProtocolEvent for WebSocketRouteEvent {
    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
        match method {
            "messageFromPage" => Ok(Self::MessageFromPage(serde_json::from_value(params)?)),
            "messageFromServer" => Ok(Self::MessageFromServer(serde_json::from_value(params)?)),
            "closePage" => Ok(Self::ClosePage(serde_json::from_value(params)?)),
            "closeServer" => Ok(Self::CloseServer(serde_json::from_value(params)?)),
            _ => Ok(Self::Unknown { method: method.to_string(), params }),
        }
    }
}

/// Channel for the `WebSocketRoute` interface (`network.yml`).
#[derive(Debug, Clone)]
pub struct WebSocketRoute {
    channel: Channel,
}

impl ChannelType for WebSocketRoute {
    const INTERFACE: &'static str = "WebSocketRoute";
    type Initializer = WebSocketRouteInitializer;
    type Event = WebSocketRouteEvent;

    fn accepts(interface: &str) -> bool {
        matches!(interface, "WebSocketRoute")
    }

    fn from_channel(channel: Channel) -> Self {
        Self { channel }
    }

    fn channel(&self) -> &Channel {
        &self.channel
    }
}

impl WebSocketRoute {
    /// `WebSocketRoute.connect` ("Connect WebSocket to server").
    pub async fn connect(&self) -> Result<(), ProtocolError> {
        self.channel.send_no_result("connect", &serde_json::json!({})).await
    }

    /// `WebSocketRoute.ensureOpened` (internal).
    pub async fn ensure_opened(&self) -> Result<(), ProtocolError> {
        self.channel.send_no_result("ensureOpened", &serde_json::json!({})).await
    }

    /// `WebSocketRoute.sendToPage` ("Send WebSocket message").
    pub async fn send_to_page(&self, params: WebSocketRouteSendToPageParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("sendToPage", &params).await
    }

    /// `WebSocketRoute.sendToServer` ("Send WebSocket message").
    pub async fn send_to_server(&self, params: WebSocketRouteSendToServerParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("sendToServer", &params).await
    }

    /// `WebSocketRoute.closePage` (internal).
    pub async fn close_page(&self, params: WebSocketRouteClosePageParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("closePage", &params).await
    }

    /// `WebSocketRoute.closeServer` (internal).
    pub async fn close_server(&self, params: WebSocketRouteCloseServerParams) -> Result<(), ProtocolError> {
        self.channel.send_no_result("closeServer", &params).await
    }
}