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

browser_commander/playwright/protocol/
frame.rs
