browser_commander/playwright/protocol/
frame.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 `Frame`.
14#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
15pub struct FrameInitializer {
16    #[serde(rename = "url")]
17    pub url: String,
18    #[serde(rename = "name")]
19    pub name: String,
20    #[serde(rename = "parentFrame", default, skip_serializing_if = "Option::is_none")]
21    pub parent_frame: Option<Ref<Frame>>,
22    #[serde(rename = "loadStates")]
23    pub load_states: Vec<LifecycleEvent>,
24}
25
26/// Parameters of `Frame.evalOnSelector` (Evaluate).
27#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
28pub struct FrameEvalOnSelectorParams {
29    #[serde(rename = "selector")]
30    pub selector: String,
31    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
32    pub strict: Option<bool>,
33    #[serde(rename = "expression")]
34    pub expression: String,
35    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
36    pub is_function: Option<bool>,
37    #[serde(rename = "arg")]
38    pub arg: SerializedArgument,
39}
40
41/// Result of `Frame.evalOnSelector` (Evaluate).
42#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
43pub struct FrameEvalOnSelectorResult {
44    #[serde(rename = "value")]
45    pub value: SerializedValue,
46}
47
48/// Parameters of `Frame.evalOnSelectorAll` (Evaluate).
49#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
50pub struct FrameEvalOnSelectorAllParams {
51    #[serde(rename = "selector")]
52    pub selector: String,
53    #[serde(rename = "expression")]
54    pub expression: String,
55    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
56    pub is_function: Option<bool>,
57    #[serde(rename = "arg")]
58    pub arg: SerializedArgument,
59}
60
61/// Result of `Frame.evalOnSelectorAll` (Evaluate).
62#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
63pub struct FrameEvalOnSelectorAllResult {
64    #[serde(rename = "value")]
65    pub value: SerializedValue,
66}
67
68/// Parameters of `Frame.addScriptTag` (Add script tag).
69#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
70pub struct FrameAddScriptTagParams {
71    #[serde(rename = "url", default, skip_serializing_if = "Option::is_none")]
72    pub url: Option<String>,
73    #[serde(rename = "content", default, skip_serializing_if = "Option::is_none")]
74    pub content: Option<String>,
75    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
76    pub r#type: Option<String>,
77}
78
79/// Result of `Frame.addScriptTag` (Add script tag).
80#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
81pub struct FrameAddScriptTagResult {
82    #[serde(rename = "element")]
83    pub element: Ref<ElementHandle>,
84}
85
86/// Parameters of `Frame.addStyleTag` (Add style tag).
87#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
88pub struct FrameAddStyleTagParams {
89    #[serde(rename = "url", default, skip_serializing_if = "Option::is_none")]
90    pub url: Option<String>,
91    #[serde(rename = "content", default, skip_serializing_if = "Option::is_none")]
92    pub content: Option<String>,
93}
94
95/// Result of `Frame.addStyleTag` (Add style tag).
96#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
97pub struct FrameAddStyleTagResult {
98    #[serde(rename = "element")]
99    pub element: Ref<ElementHandle>,
100}
101
102#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
103pub enum FrameAriaSnapshotParamsMode {
104    #[default]
105    #[serde(rename = "ai")]
106    Ai,
107    #[serde(rename = "default")]
108    Default,
109}
110
111/// Parameters of `Frame.ariaSnapshot` (Aria snapshot).
112#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
113pub struct FrameAriaSnapshotParams {
114    #[serde(rename = "mode", default, skip_serializing_if = "Option::is_none")]
115    pub mode: Option<FrameAriaSnapshotParamsMode>,
116    #[serde(rename = "selector", default, skip_serializing_if = "Option::is_none")]
117    pub selector: Option<String>,
118    #[serde(rename = "depth", default, skip_serializing_if = "Option::is_none")]
119    pub depth: Option<i64>,
120    #[serde(rename = "boxes", default, skip_serializing_if = "Option::is_none")]
121    pub boxes: Option<bool>,
122}
123
124/// Result of `Frame.ariaSnapshot` (Aria snapshot).
125#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
126pub struct FrameAriaSnapshotResult {
127    #[serde(rename = "snapshot")]
128    pub snapshot: String,
129}
130
131#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
132pub enum FrameAriaSnapshotJSONParamsMode {
133    #[default]
134    #[serde(rename = "ai")]
135    Ai,
136    #[serde(rename = "default")]
137    Default,
138}
139
140/// Parameters of `Frame.ariaSnapshotJSON` (Aria snapshot JSON).
141#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
142pub struct FrameAriaSnapshotJSONParams {
143    #[serde(rename = "mode", default, skip_serializing_if = "Option::is_none")]
144    pub mode: Option<FrameAriaSnapshotJSONParamsMode>,
145    #[serde(rename = "selector", default, skip_serializing_if = "Option::is_none")]
146    pub selector: Option<String>,
147    #[serde(rename = "depth", default, skip_serializing_if = "Option::is_none")]
148    pub depth: Option<i64>,
149    #[serde(rename = "boxes", default, skip_serializing_if = "Option::is_none")]
150    pub boxes: Option<bool>,
151}
152
153/// Result of `Frame.ariaSnapshotJSON` (Aria snapshot JSON).
154#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
155pub struct FrameAriaSnapshotJSONResult {
156    #[serde(rename = "snapshot")]
157    pub snapshot: serde_json::Value,
158}
159
160/// Parameters of `Frame.blur` (Blur).
161#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
162pub struct FrameBlurParams {
163    #[serde(rename = "selector")]
164    pub selector: String,
165    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
166    pub strict: Option<bool>,
167}
168
169#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
170pub enum FrameCheckParamsScroll {
171    #[default]
172    #[serde(rename = "auto")]
173    Auto,
174    #[serde(rename = "none")]
175    None,
176}
177
178/// Parameters of `Frame.check` (Check).
179#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
180pub struct FrameCheckParams {
181    #[serde(rename = "selector")]
182    pub selector: String,
183    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
184    pub strict: Option<bool>,
185    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
186    pub force: Option<bool>,
187    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
188    pub scroll: Option<FrameCheckParamsScroll>,
189    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
190    pub position: Option<Point>,
191    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
192    pub trial: Option<bool>,
193}
194
195#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
196pub enum FrameClickParamsScroll {
197    #[default]
198    #[serde(rename = "auto")]
199    Auto,
200    #[serde(rename = "none")]
201    None,
202}
203
204#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
205pub enum FrameClickParamsModifiers {
206    #[default]
207    #[serde(rename = "Alt")]
208    Alt,
209    #[serde(rename = "Control")]
210    Control,
211    #[serde(rename = "ControlOrMeta")]
212    ControlOrMeta,
213    #[serde(rename = "Meta")]
214    Meta,
215    #[serde(rename = "Shift")]
216    Shift,
217}
218
219#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
220pub enum FrameClickParamsButton {
221    #[default]
222    #[serde(rename = "left")]
223    Left,
224    #[serde(rename = "right")]
225    Right,
226    #[serde(rename = "middle")]
227    Middle,
228}
229
230/// Parameters of `Frame.click` (Click).
231#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
232pub struct FrameClickParams {
233    #[serde(rename = "selector")]
234    pub selector: String,
235    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
236    pub strict: Option<bool>,
237    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
238    pub force: Option<bool>,
239    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
240    pub scroll: Option<FrameClickParamsScroll>,
241    #[serde(rename = "noWaitAfter", default, skip_serializing_if = "Option::is_none")]
242    pub no_wait_after: Option<bool>,
243    #[serde(rename = "modifiers", default, skip_serializing_if = "Option::is_none")]
244    pub modifiers: Option<Vec<FrameClickParamsModifiers>>,
245    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
246    pub position: Option<Point>,
247    #[serde(rename = "delay", default, skip_serializing_if = "Option::is_none")]
248    pub delay: Option<f64>,
249    #[serde(rename = "button", default, skip_serializing_if = "Option::is_none")]
250    pub button: Option<FrameClickParamsButton>,
251    #[serde(rename = "clickCount", default, skip_serializing_if = "Option::is_none")]
252    pub click_count: Option<i64>,
253    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
254    pub trial: Option<bool>,
255    #[serde(rename = "steps", default, skip_serializing_if = "Option::is_none")]
256    pub steps: Option<i64>,
257}
258
259/// Result of `Frame.content` (Get content).
260#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
261pub struct FrameContentResult {
262    #[serde(rename = "value")]
263    pub value: String,
264}
265
266#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
267pub enum FrameDragAndDropParamsScroll {
268    #[default]
269    #[serde(rename = "auto")]
270    Auto,
271    #[serde(rename = "none")]
272    None,
273}
274
275/// Parameters of `Frame.dragAndDrop` (Drag and drop).
276#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
277pub struct FrameDragAndDropParams {
278    #[serde(rename = "source")]
279    pub source: String,
280    #[serde(rename = "target")]
281    pub target: String,
282    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
283    pub force: Option<bool>,
284    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
285    pub scroll: Option<FrameDragAndDropParamsScroll>,
286    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
287    pub trial: Option<bool>,
288    #[serde(rename = "sourcePosition", default, skip_serializing_if = "Option::is_none")]
289    pub source_position: Option<Point>,
290    #[serde(rename = "targetPosition", default, skip_serializing_if = "Option::is_none")]
291    pub target_position: Option<Point>,
292    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
293    pub strict: Option<bool>,
294    #[serde(rename = "steps", default, skip_serializing_if = "Option::is_none")]
295    pub steps: Option<i64>,
296}
297
298#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
299pub struct FrameDropParamsPayloads {
300    #[serde(rename = "name")]
301    pub name: String,
302    #[serde(rename = "mimeType", default, skip_serializing_if = "Option::is_none")]
303    pub mime_type: Option<String>,
304    #[serde(rename = "buffer")]
305    pub buffer: Binary,
306}
307
308#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
309pub struct FrameDropParamsData {
310    #[serde(rename = "mimeType")]
311    pub mime_type: String,
312    #[serde(rename = "value")]
313    pub value: String,
314}
315
316/// Parameters of `Frame.drop` (Drop files or data onto an element).
317#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
318pub struct FrameDropParams {
319    #[serde(rename = "selector")]
320    pub selector: String,
321    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
322    pub strict: Option<bool>,
323    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
324    pub position: Option<Point>,
325    #[serde(rename = "payloads", default, skip_serializing_if = "Option::is_none")]
326    pub payloads: Option<Vec<FrameDropParamsPayloads>>,
327    #[serde(rename = "localPaths", default, skip_serializing_if = "Option::is_none")]
328    pub local_paths: Option<Vec<String>>,
329    #[serde(rename = "streams", default, skip_serializing_if = "Option::is_none")]
330    pub streams: Option<Vec<Ref<WritableStream>>>,
331    #[serde(rename = "data", default, skip_serializing_if = "Option::is_none")]
332    pub data: Option<Vec<FrameDropParamsData>>,
333}
334
335#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
336pub enum FrameDblclickParamsScroll {
337    #[default]
338    #[serde(rename = "auto")]
339    Auto,
340    #[serde(rename = "none")]
341    None,
342}
343
344#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
345pub enum FrameDblclickParamsModifiers {
346    #[default]
347    #[serde(rename = "Alt")]
348    Alt,
349    #[serde(rename = "Control")]
350    Control,
351    #[serde(rename = "ControlOrMeta")]
352    ControlOrMeta,
353    #[serde(rename = "Meta")]
354    Meta,
355    #[serde(rename = "Shift")]
356    Shift,
357}
358
359#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
360pub enum FrameDblclickParamsButton {
361    #[default]
362    #[serde(rename = "left")]
363    Left,
364    #[serde(rename = "right")]
365    Right,
366    #[serde(rename = "middle")]
367    Middle,
368}
369
370/// Parameters of `Frame.dblclick` (Double click).
371#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
372pub struct FrameDblclickParams {
373    #[serde(rename = "selector")]
374    pub selector: String,
375    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
376    pub strict: Option<bool>,
377    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
378    pub force: Option<bool>,
379    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
380    pub scroll: Option<FrameDblclickParamsScroll>,
381    #[serde(rename = "modifiers", default, skip_serializing_if = "Option::is_none")]
382    pub modifiers: Option<Vec<FrameDblclickParamsModifiers>>,
383    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
384    pub position: Option<Point>,
385    #[serde(rename = "delay", default, skip_serializing_if = "Option::is_none")]
386    pub delay: Option<f64>,
387    #[serde(rename = "button", default, skip_serializing_if = "Option::is_none")]
388    pub button: Option<FrameDblclickParamsButton>,
389    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
390    pub trial: Option<bool>,
391    #[serde(rename = "steps", default, skip_serializing_if = "Option::is_none")]
392    pub steps: Option<i64>,
393}
394
395/// Parameters of `Frame.dispatchEvent` (Dispatch "{type}").
396#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
397pub struct FrameDispatchEventParams {
398    #[serde(rename = "selector")]
399    pub selector: String,
400    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
401    pub strict: Option<bool>,
402    #[serde(rename = "type")]
403    pub r#type: String,
404    #[serde(rename = "eventInit")]
405    pub event_init: SerializedArgument,
406}
407
408/// Parameters of `Frame.evaluateExpression` (Evaluate).
409#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
410pub struct FrameEvaluateExpressionParams {
411    #[serde(rename = "expression")]
412    pub expression: String,
413    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
414    pub is_function: Option<bool>,
415    #[serde(rename = "arg")]
416    pub arg: SerializedArgument,
417}
418
419/// Result of `Frame.evaluateExpression` (Evaluate).
420#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
421pub struct FrameEvaluateExpressionResult {
422    #[serde(rename = "value")]
423    pub value: SerializedValue,
424}
425
426/// Parameters of `Frame.evaluateExpressionHandle` (Evaluate).
427#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
428pub struct FrameEvaluateExpressionHandleParams {
429    #[serde(rename = "expression")]
430    pub expression: String,
431    #[serde(rename = "isFunction", default, skip_serializing_if = "Option::is_none")]
432    pub is_function: Option<bool>,
433    #[serde(rename = "arg")]
434    pub arg: SerializedArgument,
435}
436
437/// Result of `Frame.evaluateExpressionHandle` (Evaluate).
438#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
439pub struct FrameEvaluateExpressionHandleResult {
440    #[serde(rename = "handle")]
441    pub handle: Ref<JSHandle>,
442}
443
444/// Parameters of `Frame.fill` (Fill "{value}").
445#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
446pub struct FrameFillParams {
447    #[serde(rename = "selector")]
448    pub selector: String,
449    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
450    pub strict: Option<bool>,
451    #[serde(rename = "value")]
452    pub value: String,
453    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
454    pub force: Option<bool>,
455}
456
457/// Parameters of `Frame.focus` (Focus).
458#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
459pub struct FrameFocusParams {
460    #[serde(rename = "selector")]
461    pub selector: String,
462    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
463    pub strict: Option<bool>,
464}
465
466/// Result of `Frame.frameElement` (Get frame element).
467#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
468pub struct FrameFrameElementResult {
469    #[serde(rename = "element")]
470    pub element: Ref<ElementHandle>,
471}
472
473/// Parameters of `Frame.resolveSelector`.
474#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
475pub struct FrameResolveSelectorParams {
476    #[serde(rename = "selector")]
477    pub selector: String,
478}
479
480/// Result of `Frame.resolveSelector`.
481#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
482pub struct FrameResolveSelectorResult {
483    #[serde(rename = "resolvedSelector")]
484    pub resolved_selector: String,
485}
486
487/// Parameters of `Frame.highlight`.
488#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
489pub struct FrameHighlightParams {
490    #[serde(rename = "selector")]
491    pub selector: String,
492    #[serde(rename = "style", default, skip_serializing_if = "Option::is_none")]
493    pub style: Option<String>,
494}
495
496/// Parameters of `Frame.hideHighlight`.
497#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
498pub struct FrameHideHighlightParams {
499    #[serde(rename = "selector")]
500    pub selector: String,
501}
502
503/// Parameters of `Frame.getAttribute` (Get attribute "{name}").
504#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
505pub struct FrameGetAttributeParams {
506    #[serde(rename = "selector")]
507    pub selector: String,
508    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
509    pub strict: Option<bool>,
510    #[serde(rename = "name")]
511    pub name: String,
512}
513
514/// Result of `Frame.getAttribute` (Get attribute "{name}").
515#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
516pub struct FrameGetAttributeResult {
517    #[serde(rename = "value", default, skip_serializing_if = "Option::is_none")]
518    pub value: Option<String>,
519}
520
521/// Parameters of `Frame.goto` (Navigate).
522#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
523pub struct FrameGotoParams {
524    #[serde(rename = "url")]
525    pub url: String,
526    #[serde(rename = "waitUntil", default, skip_serializing_if = "Option::is_none")]
527    pub wait_until: Option<LifecycleEvent>,
528    #[serde(rename = "referer", default, skip_serializing_if = "Option::is_none")]
529    pub referer: Option<String>,
530}
531
532/// Result of `Frame.goto` (Navigate).
533#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
534pub struct FrameGotoResult {
535    #[serde(rename = "response", default, skip_serializing_if = "Option::is_none")]
536    pub response: Option<Ref<Response>>,
537}
538
539#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
540pub enum FrameHoverParamsScroll {
541    #[default]
542    #[serde(rename = "auto")]
543    Auto,
544    #[serde(rename = "none")]
545    None,
546}
547
548#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
549pub enum FrameHoverParamsModifiers {
550    #[default]
551    #[serde(rename = "Alt")]
552    Alt,
553    #[serde(rename = "Control")]
554    Control,
555    #[serde(rename = "ControlOrMeta")]
556    ControlOrMeta,
557    #[serde(rename = "Meta")]
558    Meta,
559    #[serde(rename = "Shift")]
560    Shift,
561}
562
563/// Parameters of `Frame.hover` (Hover).
564#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
565pub struct FrameHoverParams {
566    #[serde(rename = "selector")]
567    pub selector: String,
568    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
569    pub strict: Option<bool>,
570    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
571    pub force: Option<bool>,
572    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
573    pub scroll: Option<FrameHoverParamsScroll>,
574    #[serde(rename = "modifiers", default, skip_serializing_if = "Option::is_none")]
575    pub modifiers: Option<Vec<FrameHoverParamsModifiers>>,
576    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
577    pub position: Option<Point>,
578    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
579    pub trial: Option<bool>,
580}
581
582/// Parameters of `Frame.innerHTML` (Get HTML).
583#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
584pub struct FrameInnerHTMLParams {
585    #[serde(rename = "selector")]
586    pub selector: String,
587    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
588    pub strict: Option<bool>,
589}
590
591/// Result of `Frame.innerHTML` (Get HTML).
592#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
593pub struct FrameInnerHTMLResult {
594    #[serde(rename = "value")]
595    pub value: String,
596}
597
598/// Parameters of `Frame.innerText` (Get inner text).
599#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
600pub struct FrameInnerTextParams {
601    #[serde(rename = "selector")]
602    pub selector: String,
603    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
604    pub strict: Option<bool>,
605}
606
607/// Result of `Frame.innerText` (Get inner text).
608#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
609pub struct FrameInnerTextResult {
610    #[serde(rename = "value")]
611    pub value: String,
612}
613
614/// Parameters of `Frame.inputValue` (Get input value).
615#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
616pub struct FrameInputValueParams {
617    #[serde(rename = "selector")]
618    pub selector: String,
619    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
620    pub strict: Option<bool>,
621}
622
623/// Result of `Frame.inputValue` (Get input value).
624#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
625pub struct FrameInputValueResult {
626    #[serde(rename = "value")]
627    pub value: String,
628}
629
630/// Parameters of `Frame.isChecked` (Is checked).
631#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
632pub struct FrameIsCheckedParams {
633    #[serde(rename = "selector")]
634    pub selector: String,
635    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
636    pub strict: Option<bool>,
637}
638
639/// Result of `Frame.isChecked` (Is checked).
640#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
641pub struct FrameIsCheckedResult {
642    #[serde(rename = "value")]
643    pub value: bool,
644}
645
646/// Parameters of `Frame.isDisabled` (Is disabled).
647#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
648pub struct FrameIsDisabledParams {
649    #[serde(rename = "selector")]
650    pub selector: String,
651    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
652    pub strict: Option<bool>,
653}
654
655/// Result of `Frame.isDisabled` (Is disabled).
656#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
657pub struct FrameIsDisabledResult {
658    #[serde(rename = "value")]
659    pub value: bool,
660}
661
662/// Parameters of `Frame.isEnabled` (Is enabled).
663#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
664pub struct FrameIsEnabledParams {
665    #[serde(rename = "selector")]
666    pub selector: String,
667    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
668    pub strict: Option<bool>,
669}
670
671/// Result of `Frame.isEnabled` (Is enabled).
672#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
673pub struct FrameIsEnabledResult {
674    #[serde(rename = "value")]
675    pub value: bool,
676}
677
678/// Parameters of `Frame.isHidden` (Is hidden).
679#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
680pub struct FrameIsHiddenParams {
681    #[serde(rename = "selector")]
682    pub selector: String,
683    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
684    pub strict: Option<bool>,
685}
686
687/// Result of `Frame.isHidden` (Is hidden).
688#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
689pub struct FrameIsHiddenResult {
690    #[serde(rename = "value")]
691    pub value: bool,
692}
693
694/// Parameters of `Frame.isVisible` (Is visible).
695#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
696pub struct FrameIsVisibleParams {
697    #[serde(rename = "selector")]
698    pub selector: String,
699    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
700    pub strict: Option<bool>,
701}
702
703/// Result of `Frame.isVisible` (Is visible).
704#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
705pub struct FrameIsVisibleResult {
706    #[serde(rename = "value")]
707    pub value: bool,
708}
709
710/// Parameters of `Frame.isEditable` (Is editable).
711#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
712pub struct FrameIsEditableParams {
713    #[serde(rename = "selector")]
714    pub selector: String,
715    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
716    pub strict: Option<bool>,
717}
718
719/// Result of `Frame.isEditable` (Is editable).
720#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
721pub struct FrameIsEditableResult {
722    #[serde(rename = "value")]
723    pub value: bool,
724}
725
726/// Parameters of `Frame.press` (Press "{key}").
727#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
728pub struct FramePressParams {
729    #[serde(rename = "selector")]
730    pub selector: String,
731    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
732    pub strict: Option<bool>,
733    #[serde(rename = "key")]
734    pub key: String,
735    #[serde(rename = "delay", default, skip_serializing_if = "Option::is_none")]
736    pub delay: Option<f64>,
737    #[serde(rename = "noWaitAfter", default, skip_serializing_if = "Option::is_none")]
738    pub no_wait_after: Option<bool>,
739}
740
741/// Parameters of `Frame.querySelector` (Query selector).
742#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
743pub struct FrameQuerySelectorParams {
744    #[serde(rename = "selector")]
745    pub selector: String,
746    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
747    pub strict: Option<bool>,
748}
749
750/// Result of `Frame.querySelector` (Query selector).
751#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
752pub struct FrameQuerySelectorResult {
753    #[serde(rename = "element", default, skip_serializing_if = "Option::is_none")]
754    pub element: Option<Ref<ElementHandle>>,
755}
756
757/// Parameters of `Frame.querySelectorAll` (Query selector all).
758#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
759pub struct FrameQuerySelectorAllParams {
760    #[serde(rename = "selector")]
761    pub selector: String,
762}
763
764/// Result of `Frame.querySelectorAll` (Query selector all).
765#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
766pub struct FrameQuerySelectorAllResult {
767    #[serde(rename = "elements")]
768    pub elements: Vec<Ref<ElementHandle>>,
769}
770
771/// Parameters of `Frame.queryCount` (Query count).
772#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
773pub struct FrameQueryCountParams {
774    #[serde(rename = "selector")]
775    pub selector: String,
776}
777
778/// Result of `Frame.queryCount` (Query count).
779#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
780pub struct FrameQueryCountResult {
781    #[serde(rename = "value")]
782    pub value: i64,
783}
784
785#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
786pub struct FrameSelectOptionParamsOptions {
787    #[serde(rename = "valueOrLabel", default, skip_serializing_if = "Option::is_none")]
788    pub value_or_label: Option<String>,
789    #[serde(rename = "value", default, skip_serializing_if = "Option::is_none")]
790    pub value: Option<String>,
791    #[serde(rename = "label", default, skip_serializing_if = "Option::is_none")]
792    pub label: Option<String>,
793    #[serde(rename = "index", default, skip_serializing_if = "Option::is_none")]
794    pub index: Option<i64>,
795}
796
797/// Parameters of `Frame.selectOption` (Select option).
798#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
799pub struct FrameSelectOptionParams {
800    #[serde(rename = "selector")]
801    pub selector: String,
802    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
803    pub strict: Option<bool>,
804    #[serde(rename = "elements", default, skip_serializing_if = "Option::is_none")]
805    pub elements: Option<Vec<Ref<ElementHandle>>>,
806    #[serde(rename = "options", default, skip_serializing_if = "Option::is_none")]
807    pub options: Option<Vec<FrameSelectOptionParamsOptions>>,
808    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
809    pub force: Option<bool>,
810}
811
812/// Result of `Frame.selectOption` (Select option).
813#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
814pub struct FrameSelectOptionResult {
815    #[serde(rename = "values")]
816    pub values: Vec<String>,
817}
818
819/// Parameters of `Frame.setContent` (Set content).
820#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
821pub struct FrameSetContentParams {
822    #[serde(rename = "html")]
823    pub html: String,
824    #[serde(rename = "waitUntil", default, skip_serializing_if = "Option::is_none")]
825    pub wait_until: Option<LifecycleEvent>,
826}
827
828#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
829pub struct FrameSetInputFilesParamsPayloads {
830    #[serde(rename = "name")]
831    pub name: String,
832    #[serde(rename = "mimeType", default, skip_serializing_if = "Option::is_none")]
833    pub mime_type: Option<String>,
834    #[serde(rename = "buffer")]
835    pub buffer: Binary,
836}
837
838/// Parameters of `Frame.setInputFiles` (Set input files).
839#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
840pub struct FrameSetInputFilesParams {
841    #[serde(rename = "selector")]
842    pub selector: String,
843    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
844    pub strict: Option<bool>,
845    #[serde(rename = "payloads", default, skip_serializing_if = "Option::is_none")]
846    pub payloads: Option<Vec<FrameSetInputFilesParamsPayloads>>,
847    #[serde(rename = "localDirectory", default, skip_serializing_if = "Option::is_none")]
848    pub local_directory: Option<String>,
849    #[serde(rename = "directoryStream", default, skip_serializing_if = "Option::is_none")]
850    pub directory_stream: Option<Ref<WritableStream>>,
851    #[serde(rename = "localPaths", default, skip_serializing_if = "Option::is_none")]
852    pub local_paths: Option<Vec<String>>,
853    #[serde(rename = "streams", default, skip_serializing_if = "Option::is_none")]
854    pub streams: Option<Vec<Ref<WritableStream>>>,
855}
856
857#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
858pub enum FrameTapParamsScroll {
859    #[default]
860    #[serde(rename = "auto")]
861    Auto,
862    #[serde(rename = "none")]
863    None,
864}
865
866#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
867pub enum FrameTapParamsModifiers {
868    #[default]
869    #[serde(rename = "Alt")]
870    Alt,
871    #[serde(rename = "Control")]
872    Control,
873    #[serde(rename = "ControlOrMeta")]
874    ControlOrMeta,
875    #[serde(rename = "Meta")]
876    Meta,
877    #[serde(rename = "Shift")]
878    Shift,
879}
880
881/// Parameters of `Frame.tap` (Tap).
882#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
883pub struct FrameTapParams {
884    #[serde(rename = "selector")]
885    pub selector: String,
886    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
887    pub strict: Option<bool>,
888    #[serde(rename = "force", default, skip_serializing_if = "Option::is_none")]
889    pub force: Option<bool>,
890    #[serde(rename = "scroll", default, skip_serializing_if = "Option::is_none")]
891    pub scroll: Option<FrameTapParamsScroll>,
892    #[serde(rename = "modifiers", default, skip_serializing_if = "Option::is_none")]
893    pub modifiers: Option<Vec<FrameTapParamsModifiers>>,
894    #[serde(rename = "position", default, skip_serializing_if = "Option::is_none")]
895    pub position: Option<Point>,
896    #[serde(rename = "trial", default, skip_serializing_if = "Option::is_none")]
897    pub trial: Option<bool>,
898}
899
900/// Parameters of `Frame.textContent` (Get text content).
901#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
902pub struct FrameTextContentParams {
903    #[serde(rename = "selector")]
904    pub selector: String,
905    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
906    pub strict: Option<bool>,
907}
908
909/// Result of `Frame.textContent` (Get text content).
910#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
911pub struct FrameTextContentResult {
912    #[serde(rename = "value", default, skip_serializing_if = "Option::is_none")]
913    pub value: Option<String>,
914}
915
916/// Result of `Frame.title` (Get page title).
917#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
918pub struct FrameTitleResult {
919    #[serde(rename = "value")]
920    pub value: String,
921}
922
923/// Parameters of `Frame.type` (Type "{text}").
924#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
925pub struct FrameTypeParams {
926    #[serde(rename = "selector")]
927    pub selector: String,
928    #[serde(rename = "strict", default, skip_serializing_if = "Option::is_none")]
929    pub strict: Option<bool>,
930    #[serde(rename = "text")]
931    pub text: String,
932    #[serde(rename = "delay", default, skip_serializing_if = "Option::is_none")]
933    pub delay: Option<f64>,
934}
935
936#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Hash, Serialize, Deserialize)]
937pub enum FrameUncheckParamsScroll {
938    #[default]
939    #[serde(rename = "auto")]
940    Auto,
941    #[serde(rename = "none")]
942    None,
943}
944
browser_commander/playwright/protocol/frame.rs

browser_commander/playwright/protocol/
frame.rs
