browser_commander/playwright/protocol/
electron.rs

1// @generated by scripts/generate-playwright-protocol.mjs from
2// rust/protocol/playwright/*.yml. Do not edit by hand.
3
4#![allow(clippy::all, missing_docs, unused_imports)]
5
6use serde::{Deserialize, Serialize};
7
8use super::*;
9use crate::playwright::connection::{
10    Binary, Channel, ChannelType, ObjectRef, ProtocolError, ProtocolEvent, Ref,
11};
12
13/// Initializer the driver sends when it creates a `Electron`.
14#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
15pub struct ElectronInitializer {}
16
17#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
18pub enum ElectronLaunchParamsAcceptDownloads {
19    #[default]
20    #[serde(rename = "accept")]
21    Accept,
22    #[serde(rename = "deny")]
23    Deny,
24    #[serde(rename = "internal-browser-default")]
25    InternalBrowserDefault,
26}
27
28#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
29pub enum ElectronLaunchParamsColorScheme {
30    #[default]
31    #[serde(rename = "dark")]
32    Dark,
33    #[serde(rename = "light")]
34    Light,
35    #[serde(rename = "no-preference")]
36    NoPreference,
37    #[serde(rename = "no-override")]
38    NoOverride,
39}
40
41#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
42pub struct ElectronLaunchParamsGeolocation {
43    #[serde(rename = "longitude")]
44    pub longitude: f64,
45    #[serde(rename = "latitude")]
46    pub latitude: f64,
47    #[serde(rename = "accuracy", default, skip_serializing_if = "Option::is_none")]
48    pub accuracy: Option<f64>,
49}
50
51#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
52pub struct ElectronLaunchParamsRecordVideoSize {
53    #[serde(rename = "width")]
54    pub width: i64,
55    #[serde(rename = "height")]
56    pub height: i64,
57}
58
59#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
60pub struct ElectronLaunchParamsRecordVideoShowActions {
61    /// Properties of the `ShowActionsOptions` mixin.
62    #[serde(flatten)]
63    pub show_actions_options: ShowActionsOptions,
64}
65
66#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
67pub struct ElectronLaunchParamsRecordVideo {
68    #[serde(rename = "dir", default, skip_serializing_if = "Option::is_none")]
69    pub dir: Option<String>,
70    #[serde(rename = "size", default, skip_serializing_if = "Option::is_none")]
71    pub size: Option<ElectronLaunchParamsRecordVideoSize>,
72    #[serde(rename = "showActions", default, skip_serializing_if = "Option::is_none")]
73    pub show_actions: Option<ElectronLaunchParamsRecordVideoShowActions>,
74}
75
76/// Parameters of `Electron.launch` (Launch electron).
77#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
78pub struct ElectronLaunchParams {
79    #[serde(rename = "executablePath", default, skip_serializing_if = "Option::is_none")]
80    pub executable_path: Option<String>,
81    #[serde(rename = "args", default, skip_serializing_if = "Option::is_none")]
82    pub args: Option<Vec<String>>,
83    #[serde(rename = "chromiumSandbox", default, skip_serializing_if = "Option::is_none")]
84    pub chromium_sandbox: Option<bool>,
85    #[serde(rename = "cwd", default, skip_serializing_if = "Option::is_none")]
86    pub cwd: Option<String>,
87    #[serde(rename = "env", default, skip_serializing_if = "Option::is_none")]
88    pub env: Option<Vec<NameValue>>,
89    #[serde(rename = "acceptDownloads", default, skip_serializing_if = "Option::is_none")]
90    pub accept_downloads: Option<ElectronLaunchParamsAcceptDownloads>,
91    #[serde(rename = "bypassCSP", default, skip_serializing_if = "Option::is_none")]
92    pub bypass_csp: Option<bool>,
93    #[serde(rename = "colorScheme", default, skip_serializing_if = "Option::is_none")]
94    pub color_scheme: Option<ElectronLaunchParamsColorScheme>,
95    #[serde(rename = "extraHTTPHeaders", default, skip_serializing_if = "Option::is_none")]
96    pub extra_http_headers: Option<Vec<NameValue>>,
97    #[serde(rename = "geolocation", default, skip_serializing_if = "Option::is_none")]
98    pub geolocation: Option<ElectronLaunchParamsGeolocation>,
99    #[serde(rename = "httpCredentials", default, skip_serializing_if = "Option::is_none")]
100    pub http_credentials: Option<Vec<HttpCredentials>>,
101    #[serde(rename = "ignoreHTTPSErrors", default, skip_serializing_if = "Option::is_none")]
102    pub ignore_https_errors: Option<bool>,
103    #[serde(rename = "locale", default, skip_serializing_if = "Option::is_none")]
104    pub locale: Option<String>,
105    #[serde(rename = "offline", default, skip_serializing_if = "Option::is_none")]
106    pub offline: Option<bool>,
107    #[serde(rename = "recordVideo", default, skip_serializing_if = "Option::is_none")]
108    pub record_video: Option<ElectronLaunchParamsRecordVideo>,
109    #[serde(rename = "strictSelectors", default, skip_serializing_if = "Option::is_none")]
110    pub strict_selectors: Option<bool>,
111    #[serde(rename = "timezoneId", default, skip_serializing_if = "Option::is_none")]
112    pub timezone_id: Option<String>,
113    #[serde(rename = "tracesDir", default, skip_serializing_if = "Option::is_none")]
114    pub traces_dir: Option<String>,
115    #[serde(rename = "artifactsDir", default, skip_serializing_if = "Option::is_none")]
116    pub artifacts_dir: Option<String>,
117    #[serde(rename = "selectorEngines", default, skip_serializing_if = "Option::is_none")]
118    pub selector_engines: Option<Vec<SelectorEngine>>,
119    #[serde(rename = "testIdAttributeName", default, skip_serializing_if = "Option::is_none")]
120    pub test_id_attribute_name: Option<String>,
121}
122
123/// Result of `Electron.launch` (Launch electron).
124#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
125pub struct ElectronLaunchResult {
126    #[serde(rename = "electronApplication")]
127    pub electron_application: Ref<ElectronApplication>,
128}
129
130/// Events a `Electron` channel can emit.
131#[derive(Debug, Clone, PartialEq)]
132pub enum ElectronEvent {
133    /// An event this binding does not know (a newer driver).
134    Unknown {
135        /// Event name.
136        method: String,
137        /// Raw event parameters.
138        params: serde_json::Value,
139    },
140}
141
142impl ProtocolEvent for ElectronEvent {
143    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
144        match method {
145            _ => Ok(Self::Unknown { method: method.to_string(), params }),
146        }
147    }
148}
149
150/// Channel for the `Electron` interface (`electron.yml`).
151#[derive(Debug, Clone)]
152pub struct Electron {
153    channel: Channel,
154}
155
156impl ChannelType for Electron {
157    const INTERFACE: &'static str = "Electron";
158    type Initializer = ElectronInitializer;
159    type Event = ElectronEvent;
160
161    fn accepts(interface: &str) -> bool {
162        matches!(interface, "Electron")
163    }
164
165    fn from_channel(channel: Channel) -> Self {
166        Self { channel }
167    }
168
169    fn channel(&self) -> &Channel {
170        &self.channel
171    }
172}
173
174impl Electron {
175    /// `Electron.launch` ("Launch electron").
176    pub async fn launch(&self, params: ElectronLaunchParams) -> Result<ElectronLaunchResult, ProtocolError> {
177        self.channel.send("launch", &params).await
178    }
179}
browser_commander/playwright/protocol/electron.rs

browser_commander/playwright/protocol/
electron.rs
