browser-commander 0.19.0

Universal browser automation library that supports multiple browser engines with a unified API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

// @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 `CDPSession`.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CDPSessionInitializer {}

/// Parameters of `CDPSession.send` (Send CDP command).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CDPSessionSendParams {
    #[serde(rename = "method")]
    pub method: String,
    #[serde(rename = "params", default, skip_serializing_if = "Option::is_none")]
    pub params: Option<serde_json::Value>,
}

/// Result of `CDPSession.send` (Send CDP command).
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CDPSessionSendResult {
    #[serde(rename = "result")]
    pub result: serde_json::Value,
}

/// Payload of the `CDPSession.event` event.
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct CDPSessionEventEventParams {
    #[serde(rename = "method")]
    pub method: String,
    #[serde(rename = "params", default, skip_serializing_if = "Option::is_none")]
    pub params: Option<serde_json::Value>,
}

/// Events a `CDPSession` channel can emit.
#[derive(Debug, Clone, PartialEq)]
pub enum CDPSessionEvent {
    /// `CDPSession.event`
    Event(CDPSessionEventEventParams),
    /// `CDPSession.close`
    Close,
    /// 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 CDPSessionEvent {
    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
        match method {
            "event" => Ok(Self::Event(serde_json::from_value(params)?)),
            "close" => Ok(Self::Close),
            _ => Ok(Self::Unknown { method: method.to_string(), params }),
        }
    }
}

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

impl ChannelType for CDPSession {
    const INTERFACE: &'static str = "CDPSession";
    type Initializer = CDPSessionInitializer;
    type Event = CDPSessionEvent;

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

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

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

impl CDPSession {
    /// `CDPSession.send` ("Send CDP command").
    pub async fn send(&self, params: CDPSessionSendParams) -> Result<CDPSessionSendResult, ProtocolError> {
        self.channel.send("send", &params).await
    }

    /// `CDPSession.detach` ("Detach CDP session").
    pub async fn detach(&self) -> Result<(), ProtocolError> {
        self.channel.send_no_result("detach", &serde_json::json!({})).await
    }
}