Skip to main content

cdp_protocol/
dom_debugger.rs

1// Auto-generated from Chrome at version 146.0.7680.165 domain: DOMDebugger
2#![allow(dead_code)]
3use super::dom;
4use super::runtime;
5#[allow(unused_imports)]
6use super::types::*;
7#[allow(unused_imports)]
8use derive_builder::Builder;
9#[allow(unused_imports)]
10use serde::{Deserialize, Serialize};
11#[allow(unused_imports)]
12use serde_json::Value as Json;
13#[allow(deprecated)]
14#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
15pub enum DomBreakpointType {
16    #[serde(rename = "subtree-modified")]
17    SubtreeModified,
18    #[serde(rename = "attribute-modified")]
19    AttributeModified,
20    #[serde(rename = "node-removed")]
21    NodeRemoved,
22}
23#[allow(deprecated)]
24#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
25pub enum CspViolationType {
26    #[serde(rename = "trustedtype-sink-violation")]
27    TrustedtypeSinkViolation,
28    #[serde(rename = "trustedtype-policy-violation")]
29    TrustedtypePolicyViolation,
30}
31#[allow(deprecated)]
32#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
33#[builder(setter(into, strip_option))]
34#[serde(rename_all = "camelCase")]
35#[doc = "Object event listener."]
36pub struct EventListener {
37    #[serde(default)]
38    #[doc = "`EventListener`'s type."]
39    pub r#type: String,
40    #[serde(default)]
41    #[doc = "`EventListener`'s useCapture."]
42    pub use_capture: bool,
43    #[serde(default)]
44    #[doc = "`EventListener`'s passive flag."]
45    pub passive: bool,
46    #[serde(default)]
47    #[doc = "`EventListener`'s once flag."]
48    pub once: bool,
49    #[doc = "Script id of the handler code."]
50    pub script_id: runtime::ScriptId,
51    #[serde(default)]
52    #[doc = "Line number in the script (0-based)."]
53    pub line_number: JsUInt,
54    #[serde(default)]
55    #[doc = "Column number in the script (0-based)."]
56    pub column_number: JsUInt,
57    #[builder(default)]
58    #[serde(skip_serializing_if = "Option::is_none")]
59    #[doc = "Event handler function value."]
60    pub handler: Option<runtime::RemoteObject>,
61    #[builder(default)]
62    #[serde(skip_serializing_if = "Option::is_none")]
63    #[doc = "Event original handler function value."]
64    pub original_handler: Option<runtime::RemoteObject>,
65    #[builder(default)]
66    #[serde(skip_serializing_if = "Option::is_none")]
67    #[doc = "Node the listener is added to (if any)."]
68    pub backend_node_id: Option<dom::BackendNodeId>,
69}
70#[allow(deprecated)]
71#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
72#[builder(setter(into, strip_option))]
73#[serde(rename_all = "camelCase")]
74#[doc = "Returns event listeners of the given object."]
75pub struct GetEventListeners {
76    #[doc = "Identifier of the object to return listeners for."]
77    pub object_id: runtime::RemoteObjectId,
78    #[builder(default)]
79    #[serde(skip_serializing_if = "Option::is_none")]
80    #[serde(default)]
81    #[doc = "The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the\n entire subtree or provide an integer larger than 0."]
82    pub depth: Option<JsUInt>,
83    #[builder(default)]
84    #[serde(skip_serializing_if = "Option::is_none")]
85    #[serde(default)]
86    #[doc = "Whether or not iframes and shadow roots should be traversed when returning the subtree\n (default is false). Reports listeners for all contexts if pierce is enabled."]
87    pub pierce: Option<bool>,
88}
89#[allow(deprecated)]
90#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
91#[builder(setter(into, strip_option))]
92#[serde(rename_all = "camelCase")]
93#[doc = "Removes DOM breakpoint that was set using `setDOMBreakpoint`."]
94pub struct RemoveDOMBreakpoint {
95    #[doc = "Identifier of the node to remove breakpoint from."]
96    pub node_id: dom::NodeId,
97    #[doc = "Type of the breakpoint to remove."]
98    pub r#type: DomBreakpointType,
99}
100#[allow(deprecated)]
101#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
102#[builder(setter(into, strip_option))]
103#[serde(rename_all = "camelCase")]
104#[doc = "Removes breakpoint on particular DOM event."]
105pub struct RemoveEventListenerBreakpoint {
106    #[serde(default)]
107    #[doc = "Event name."]
108    pub event_name: String,
109    #[builder(default)]
110    #[serde(skip_serializing_if = "Option::is_none")]
111    #[serde(default)]
112    #[doc = "EventTarget interface name."]
113    pub target_name: Option<String>,
114}
115#[allow(deprecated)]
116#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
117#[builder(setter(into, strip_option))]
118#[serde(rename_all = "camelCase")]
119#[doc = "Removes breakpoint on particular native event."]
120#[deprecated]
121pub struct RemoveInstrumentationBreakpoint {
122    #[serde(default)]
123    #[doc = "Instrumentation name to stop on."]
124    pub event_name: String,
125}
126#[allow(deprecated)]
127#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
128#[builder(setter(into, strip_option))]
129#[serde(rename_all = "camelCase")]
130#[doc = "Removes breakpoint from XMLHttpRequest."]
131pub struct RemoveXHRBreakpoint {
132    #[serde(default)]
133    #[doc = "Resource URL substring."]
134    pub url: String,
135}
136#[allow(deprecated)]
137#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
138#[builder(setter(into, strip_option))]
139#[serde(rename_all = "camelCase")]
140#[doc = "Sets breakpoint on particular CSP violations."]
141pub struct SetBreakOnCSPViolation {
142    #[doc = "CSP Violations to stop upon."]
143    pub violation_types: Vec<CspViolationType>,
144}
145#[allow(deprecated)]
146#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
147#[builder(setter(into, strip_option))]
148#[serde(rename_all = "camelCase")]
149#[doc = "Sets breakpoint on particular operation with DOM."]
150pub struct SetDOMBreakpoint {
151    #[doc = "Identifier of the node to set breakpoint on."]
152    pub node_id: dom::NodeId,
153    #[doc = "Type of the operation to stop upon."]
154    pub r#type: DomBreakpointType,
155}
156#[allow(deprecated)]
157#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
158#[builder(setter(into, strip_option))]
159#[serde(rename_all = "camelCase")]
160#[doc = "Sets breakpoint on particular DOM event."]
161pub struct SetEventListenerBreakpoint {
162    #[serde(default)]
163    #[doc = "DOM Event name to stop on (any DOM event will do)."]
164    pub event_name: String,
165    #[builder(default)]
166    #[serde(skip_serializing_if = "Option::is_none")]
167    #[serde(default)]
168    #[doc = "EventTarget interface name to stop on. If equal to `\"*\"` or not provided, will stop on any\n EventTarget."]
169    pub target_name: Option<String>,
170}
171#[allow(deprecated)]
172#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
173#[builder(setter(into, strip_option))]
174#[serde(rename_all = "camelCase")]
175#[doc = "Sets breakpoint on particular native event."]
176#[deprecated]
177pub struct SetInstrumentationBreakpoint {
178    #[serde(default)]
179    #[doc = "Instrumentation name to stop on."]
180    pub event_name: String,
181}
182#[allow(deprecated)]
183#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
184#[builder(setter(into, strip_option))]
185#[serde(rename_all = "camelCase")]
186#[doc = "Sets breakpoint on XMLHttpRequest."]
187pub struct SetXHRBreakpoint {
188    #[serde(default)]
189    #[doc = "Resource URL substring. All XHRs having this substring in the URL will get stopped upon."]
190    pub url: String,
191}
192#[allow(deprecated)]
193#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
194#[serde(rename_all = "camelCase")]
195#[doc = "Returns event listeners of the given object."]
196pub struct GetEventListenersReturnObject {
197    #[doc = "Array of relevant listeners."]
198    pub listeners: Vec<EventListener>,
199}
200#[allow(deprecated)]
201#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
202#[doc = "Removes DOM breakpoint that was set using `setDOMBreakpoint`."]
203pub struct RemoveDOMBreakpointReturnObject(pub Option<Json>);
204#[allow(deprecated)]
205#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
206#[doc = "Removes breakpoint on particular DOM event."]
207pub struct RemoveEventListenerBreakpointReturnObject(pub Option<Json>);
208#[allow(deprecated)]
209#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
210#[doc = "Removes breakpoint on particular native event."]
211#[deprecated]
212pub struct RemoveInstrumentationBreakpointReturnObject(pub Option<Json>);
213#[allow(deprecated)]
214#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
215#[doc = "Removes breakpoint from XMLHttpRequest."]
216pub struct RemoveXHRBreakpointReturnObject(pub Option<Json>);
217#[allow(deprecated)]
218#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
219#[doc = "Sets breakpoint on particular CSP violations."]
220pub struct SetBreakOnCSPViolationReturnObject(pub Option<Json>);
221#[allow(deprecated)]
222#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
223#[doc = "Sets breakpoint on particular operation with DOM."]
224pub struct SetDOMBreakpointReturnObject(pub Option<Json>);
225#[allow(deprecated)]
226#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
227#[doc = "Sets breakpoint on particular DOM event."]
228pub struct SetEventListenerBreakpointReturnObject(pub Option<Json>);
229#[allow(deprecated)]
230#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
231#[doc = "Sets breakpoint on particular native event."]
232#[deprecated]
233pub struct SetInstrumentationBreakpointReturnObject(pub Option<Json>);
234#[allow(deprecated)]
235#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
236#[doc = "Sets breakpoint on XMLHttpRequest."]
237pub struct SetXHRBreakpointReturnObject(pub Option<Json>);
238#[allow(deprecated)]
239impl Method for GetEventListeners {
240    const NAME: &'static str = "DOMDebugger.getEventListeners";
241    type ReturnObject = GetEventListenersReturnObject;
242}
243#[allow(deprecated)]
244impl Method for RemoveDOMBreakpoint {
245    const NAME: &'static str = "DOMDebugger.removeDOMBreakpoint";
246    type ReturnObject = RemoveDOMBreakpointReturnObject;
247}
248#[allow(deprecated)]
249impl Method for RemoveEventListenerBreakpoint {
250    const NAME: &'static str = "DOMDebugger.removeEventListenerBreakpoint";
251    type ReturnObject = RemoveEventListenerBreakpointReturnObject;
252}
253#[allow(deprecated)]
254impl Method for RemoveInstrumentationBreakpoint {
255    const NAME: &'static str = "DOMDebugger.removeInstrumentationBreakpoint";
256    type ReturnObject = RemoveInstrumentationBreakpointReturnObject;
257}
258#[allow(deprecated)]
259impl Method for RemoveXHRBreakpoint {
260    const NAME: &'static str = "DOMDebugger.removeXHRBreakpoint";
261    type ReturnObject = RemoveXHRBreakpointReturnObject;
262}
263#[allow(deprecated)]
264impl Method for SetBreakOnCSPViolation {
265    const NAME: &'static str = "DOMDebugger.setBreakOnCSPViolation";
266    type ReturnObject = SetBreakOnCSPViolationReturnObject;
267}
268#[allow(deprecated)]
269impl Method for SetDOMBreakpoint {
270    const NAME: &'static str = "DOMDebugger.setDOMBreakpoint";
271    type ReturnObject = SetDOMBreakpointReturnObject;
272}
273#[allow(deprecated)]
274impl Method for SetEventListenerBreakpoint {
275    const NAME: &'static str = "DOMDebugger.setEventListenerBreakpoint";
276    type ReturnObject = SetEventListenerBreakpointReturnObject;
277}
278#[allow(deprecated)]
279impl Method for SetInstrumentationBreakpoint {
280    const NAME: &'static str = "DOMDebugger.setInstrumentationBreakpoint";
281    type ReturnObject = SetInstrumentationBreakpointReturnObject;
282}
283#[allow(deprecated)]
284impl Method for SetXHRBreakpoint {
285    const NAME: &'static str = "DOMDebugger.setXHRBreakpoint";
286    type ReturnObject = SetXHRBreakpointReturnObject;
287}
288#[allow(dead_code)]
289pub mod events {
290    #[allow(unused_imports)]
291    use super::super::types::*;
292    #[allow(unused_imports)]
293    use derive_builder::Builder;
294    #[allow(unused_imports)]
295    use serde::{Deserialize, Serialize};
296    #[allow(unused_imports)]
297    use serde_json::Value as Json;
298}