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 ElectronLaunchParamsHttpCredentials {
53    #[serde(rename = "username")]
54    pub username: String,
55    #[serde(rename = "password")]
56    pub password: String,
57    #[serde(rename = "origin", default, skip_serializing_if = "Option::is_none")]
58    pub origin: Option<String>,
59}
60
61#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
62pub struct ElectronLaunchParamsRecordVideoSize {
63    #[serde(rename = "width")]
64    pub width: i64,
65    #[serde(rename = "height")]
66    pub height: i64,
67}
68
69#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
70pub struct ElectronLaunchParamsRecordVideoShowActions {
71    /// Properties of the `ShowActionsOptions` mixin.
72    #[serde(flatten)]
73    pub show_actions_options: ShowActionsOptions,
74}
75
76#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
77pub struct ElectronLaunchParamsRecordVideo {
78    #[serde(rename = "dir", default, skip_serializing_if = "Option::is_none")]
79    pub dir: Option<String>,
80    #[serde(rename = "size", default, skip_serializing_if = "Option::is_none")]
81    pub size: Option<ElectronLaunchParamsRecordVideoSize>,
82    #[serde(rename = "showActions", default, skip_serializing_if = "Option::is_none")]
83    pub show_actions: Option<ElectronLaunchParamsRecordVideoShowActions>,
84}
85
86/// Parameters of `Electron.launch` (Launch electron).
87#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
88pub struct ElectronLaunchParams {
89    #[serde(rename = "executablePath", default, skip_serializing_if = "Option::is_none")]
90    pub executable_path: Option<String>,
91    #[serde(rename = "args", default, skip_serializing_if = "Option::is_none")]
92    pub args: Option<Vec<String>>,
93    #[serde(rename = "chromiumSandbox", default, skip_serializing_if = "Option::is_none")]
94    pub chromium_sandbox: Option<bool>,
95    #[serde(rename = "cwd", default, skip_serializing_if = "Option::is_none")]
96    pub cwd: Option<String>,
97    #[serde(rename = "env", default, skip_serializing_if = "Option::is_none")]
98    pub env: Option<Vec<NameValue>>,
99    #[serde(rename = "acceptDownloads", default, skip_serializing_if = "Option::is_none")]
100    pub accept_downloads: Option<ElectronLaunchParamsAcceptDownloads>,
101    #[serde(rename = "bypassCSP", default, skip_serializing_if = "Option::is_none")]
102    pub bypass_csp: Option<bool>,
103    #[serde(rename = "colorScheme", default, skip_serializing_if = "Option::is_none")]
104    pub color_scheme: Option<ElectronLaunchParamsColorScheme>,
105    #[serde(rename = "extraHTTPHeaders", default, skip_serializing_if = "Option::is_none")]
106    pub extra_http_headers: Option<Vec<NameValue>>,
107    #[serde(rename = "geolocation", default, skip_serializing_if = "Option::is_none")]
108    pub geolocation: Option<ElectronLaunchParamsGeolocation>,
109    #[serde(rename = "httpCredentials", default, skip_serializing_if = "Option::is_none")]
110    pub http_credentials: Option<ElectronLaunchParamsHttpCredentials>,
111    #[serde(rename = "ignoreHTTPSErrors", default, skip_serializing_if = "Option::is_none")]
112    pub ignore_https_errors: Option<bool>,
113    #[serde(rename = "locale", default, skip_serializing_if = "Option::is_none")]
114    pub locale: Option<String>,
115    #[serde(rename = "offline", default, skip_serializing_if = "Option::is_none")]
116    pub offline: Option<bool>,
117    #[serde(rename = "recordVideo", default, skip_serializing_if = "Option::is_none")]
118    pub record_video: Option<ElectronLaunchParamsRecordVideo>,
119    #[serde(rename = "strictSelectors", default, skip_serializing_if = "Option::is_none")]
120    pub strict_selectors: Option<bool>,
121    #[serde(rename = "timezoneId", default, skip_serializing_if = "Option::is_none")]
122    pub timezone_id: Option<String>,
123    #[serde(rename = "tracesDir", default, skip_serializing_if = "Option::is_none")]
124    pub traces_dir: Option<String>,
125    #[serde(rename = "artifactsDir", default, skip_serializing_if = "Option::is_none")]
126    pub artifacts_dir: Option<String>,
127    #[serde(rename = "selectorEngines", default, skip_serializing_if = "Option::is_none")]
128    pub selector_engines: Option<Vec<SelectorEngine>>,
129    #[serde(rename = "testIdAttributeName", default, skip_serializing_if = "Option::is_none")]
130    pub test_id_attribute_name: Option<String>,
131}
132
133/// Result of `Electron.launch` (Launch electron).
134#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
135pub struct ElectronLaunchResult {
136    #[serde(rename = "electronApplication")]
137    pub electron_application: Ref<ElectronApplication>,
138}
139
140/// Events a `Electron` channel can emit.
141#[derive(Debug, Clone, PartialEq)]
142pub enum ElectronEvent {
143    /// An event this binding does not know (a newer driver).
144    Unknown {
145        /// Event name.
146        method: String,
147        /// Raw event parameters.
148        params: serde_json::Value,
149    },
150}
151
152impl ProtocolEvent for ElectronEvent {
153    fn parse(method: &str, params: serde_json::Value) -> Result<Self, serde_json::Error> {
154        match method {
155            _ => Ok(Self::Unknown { method: method.to_string(), params }),
156        }
157    }
158}
159
160/// Channel for the `Electron` interface (`electron.yml`).
161#[derive(Debug, Clone)]
162pub struct Electron {
163    channel: Channel,
164}
165
166impl ChannelType for Electron {
167    const INTERFACE: &'static str = "Electron";
168    type Initializer = ElectronInitializer;
169    type Event = ElectronEvent;
170
171    fn accepts(interface: &str) -> bool {
172        matches!(interface, "Electron")
173    }
174
175    fn from_channel(channel: Channel) -> Self {
176        Self { channel }
177    }
178
179    fn channel(&self) -> &Channel {
180        &self.channel
181    }
182}
183
184impl Electron {
185    /// `Electron.launch` ("Launch electron").
186    pub async fn launch(&self, params: ElectronLaunchParams) -> Result<ElectronLaunchResult, ProtocolError> {
187        self.channel.send("launch", &params).await
188    }
189}
browser_commander/playwright/protocol/electron.rs

browser_commander/playwright/protocol/
electron.rs
