cdp-protocol 0.3.1

A Rust implementation of the Chrome DevTools Protocol
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
// Auto-generated from Chrome at version 146.0.7680.165 domain: IndexedDB
#![allow(dead_code)]
use super::runtime;
use super::storage;
#[allow(unused_imports)]
use super::types::*;
#[allow(unused_imports)]
use derive_builder::Builder;
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
#[allow(unused_imports)]
use serde_json::Value as Json;
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
pub enum KeyType {
    #[serde(rename = "number")]
    Number,
    #[serde(rename = "string")]
    String,
    #[serde(rename = "date")]
    Date,
    #[serde(rename = "array")]
    Array,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
pub enum KeyPathType {
    #[serde(rename = "null")]
    Null,
    #[serde(rename = "string")]
    String,
    #[serde(rename = "array")]
    Array,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Database with an array of object stores."]
pub struct DatabaseWithObjectStores {
    #[serde(default)]
    #[doc = "Database name."]
    pub name: String,
    #[serde(default)]
    #[doc = "Database version (type is not 'integer', as the standard\n requires the version number to be 'unsigned long long')"]
    pub version: JsFloat,
    #[doc = "Object stores in this database."]
    pub object_stores: Vec<ObjectStore>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Object store."]
pub struct ObjectStore {
    #[serde(default)]
    #[doc = "Object store name."]
    pub name: String,
    #[doc = "Object store key path."]
    pub key_path: KeyPath,
    #[serde(default)]
    #[doc = "If true, object store has auto increment flag set."]
    pub auto_increment: bool,
    #[doc = "Indexes in this object store."]
    pub indexes: Vec<ObjectStoreIndex>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Object store index."]
pub struct ObjectStoreIndex {
    #[serde(default)]
    #[doc = "Index name."]
    pub name: String,
    #[doc = "Index key path."]
    pub key_path: KeyPath,
    #[serde(default)]
    #[doc = "If true, index is unique."]
    pub unique: bool,
    #[serde(default)]
    #[doc = "If true, index allows multiple entries for a key."]
    pub multi_entry: bool,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Key."]
pub struct Key {
    #[doc = "Key type."]
    pub r#type: KeyType,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Number value."]
    pub number: Option<JsFloat>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "String value."]
    pub string: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Date value."]
    pub date: Option<JsFloat>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Array value."]
    pub array: Option<Vec<Key>>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Key range."]
pub struct KeyRange {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Lower bound."]
    pub lower: Option<Key>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Upper bound."]
    pub upper: Option<Key>,
    #[serde(default)]
    #[doc = "If true lower bound is open."]
    pub lower_open: bool,
    #[serde(default)]
    #[doc = "If true upper bound is open."]
    pub upper_open: bool,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Data entry."]
pub struct DataEntry {
    #[doc = "Key object."]
    pub key: runtime::RemoteObject,
    #[doc = "Primary key object."]
    pub primary_key: runtime::RemoteObject,
    #[doc = "Value object."]
    pub value: runtime::RemoteObject,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Key path."]
pub struct KeyPath {
    #[doc = "Key path type."]
    pub r#type: KeyPathType,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "String value."]
    pub string: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Array value."]
    pub array: Option<Vec<String>>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Clears all entries from an object store."]
pub struct ClearObjectStore {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    #[doc = "Database name."]
    pub database_name: String,
    #[serde(default)]
    #[doc = "Object store name."]
    pub object_store_name: String,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Deletes a database."]
pub struct DeleteDatabase {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    #[doc = "Database name."]
    pub database_name: String,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Delete a range of entries from an object store"]
pub struct DeleteObjectStoreEntries {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    pub database_name: String,
    #[serde(default)]
    pub object_store_name: String,
    #[doc = "Range of entry keys to delete"]
    pub key_range: KeyRange,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
pub struct Disable(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
pub struct Enable(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Requests data from object store or index."]
pub struct RequestData {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    #[doc = "Database name."]
    pub database_name: String,
    #[serde(default)]
    #[doc = "Object store name."]
    pub object_store_name: String,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Index name. If not specified, it performs an object store data request."]
    pub index_name: Option<String>,
    #[serde(default)]
    #[doc = "Number of records to skip."]
    pub skip_count: JsUInt,
    #[serde(default)]
    #[doc = "Number of records to fetch."]
    pub page_size: JsUInt,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Key range."]
    pub key_range: Option<KeyRange>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Gets metadata of an object store."]
pub struct GetMetadata {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    #[doc = "Database name."]
    pub database_name: String,
    #[serde(default)]
    #[doc = "Object store name."]
    pub object_store_name: String,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Requests database with given name in given frame."]
pub struct RequestDatabase {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
    #[serde(default)]
    #[doc = "Database name."]
    pub database_name: String,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[builder(setter(into, strip_option))]
#[serde(rename_all = "camelCase")]
#[doc = "Requests database names for given security origin."]
pub struct RequestDatabaseNames {
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\n Security origin."]
    pub security_origin: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    #[doc = "Storage key."]
    pub storage_key: Option<String>,
    #[builder(default)]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    pub storage_bucket: Option<storage::StorageBucket>,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
#[doc = "Clears all entries from an object store."]
pub struct ClearObjectStoreReturnObject(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
#[doc = "Deletes a database."]
pub struct DeleteDatabaseReturnObject(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
#[doc = "Delete a range of entries from an object store"]
pub struct DeleteObjectStoreEntriesReturnObject(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
#[doc = "Disables events from backend."]
pub struct DisableReturnObject(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq)]
#[doc = "Enables events from backend."]
pub struct EnableReturnObject(pub Option<Json>);
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[serde(rename_all = "camelCase")]
#[doc = "Requests data from object store or index."]
pub struct RequestDataReturnObject {
    #[doc = "Array of object store data entries."]
    pub object_store_data_entries: Vec<DataEntry>,
    #[serde(default)]
    #[doc = "If true, there are more entries to fetch in the given range."]
    pub has_more: bool,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[serde(rename_all = "camelCase")]
#[doc = "Gets metadata of an object store."]
pub struct GetMetadataReturnObject {
    #[serde(default)]
    #[doc = "the entries count"]
    pub entries_count: JsFloat,
    #[serde(default)]
    #[doc = "the current value of key generator, to become the next inserted\n key into the object store. Valid if objectStore.autoIncrement\n is true."]
    pub key_generator_value: JsFloat,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[serde(rename_all = "camelCase")]
#[doc = "Requests database with given name in given frame."]
pub struct RequestDatabaseReturnObject {
    #[doc = "Database with an array of object stores."]
    pub database_with_object_stores: DatabaseWithObjectStores,
}
#[allow(deprecated)]
#[derive(Deserialize, Serialize, Debug, Clone, PartialEq, Builder)]
#[serde(rename_all = "camelCase")]
#[doc = "Requests database names for given security origin."]
pub struct RequestDatabaseNamesReturnObject {
    #[doc = "Database names for origin."]
    pub database_names: Vec<String>,
}
#[allow(deprecated)]
impl Method for ClearObjectStore {
    const NAME: &'static str = "IndexedDB.clearObjectStore";
    type ReturnObject = ClearObjectStoreReturnObject;
}
#[allow(deprecated)]
impl Method for DeleteDatabase {
    const NAME: &'static str = "IndexedDB.deleteDatabase";
    type ReturnObject = DeleteDatabaseReturnObject;
}
#[allow(deprecated)]
impl Method for DeleteObjectStoreEntries {
    const NAME: &'static str = "IndexedDB.deleteObjectStoreEntries";
    type ReturnObject = DeleteObjectStoreEntriesReturnObject;
}
#[allow(deprecated)]
impl Method for Disable {
    const NAME: &'static str = "IndexedDB.disable";
    type ReturnObject = DisableReturnObject;
}
#[allow(deprecated)]
impl Method for Enable {
    const NAME: &'static str = "IndexedDB.enable";
    type ReturnObject = EnableReturnObject;
}
#[allow(deprecated)]
impl Method for RequestData {
    const NAME: &'static str = "IndexedDB.requestData";
    type ReturnObject = RequestDataReturnObject;
}
#[allow(deprecated)]
impl Method for GetMetadata {
    const NAME: &'static str = "IndexedDB.getMetadata";
    type ReturnObject = GetMetadataReturnObject;
}
#[allow(deprecated)]
impl Method for RequestDatabase {
    const NAME: &'static str = "IndexedDB.requestDatabase";
    type ReturnObject = RequestDatabaseReturnObject;
}
#[allow(deprecated)]
impl Method for RequestDatabaseNames {
    const NAME: &'static str = "IndexedDB.requestDatabaseNames";
    type ReturnObject = RequestDatabaseNamesReturnObject;
}
#[allow(dead_code)]
pub mod events {
    #[allow(unused_imports)]
    use super::super::types::*;
    #[allow(unused_imports)]
    use derive_builder::Builder;
    #[allow(unused_imports)]
    use serde::{Deserialize, Serialize};
    #[allow(unused_imports)]
    use serde_json::Value as Json;
}