rustenium-cdp-definitions 0.1.1

Generated Chrome DevTools Protocol type definitions for Rustenium
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
use serde::{Deserialize, Serialize};
#[doc = "Clears all entries from an object store.\n[clearObjectStore](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-clearObjectStore)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClearObjectStoreParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[doc = "Database name."]
    #[serde(rename = "databaseName")]
    pub database_name: String,
    #[doc = "Object store name."]
    #[serde(rename = "objectStoreName")]
    pub object_store_name: String,
}
impl ClearObjectStoreParams {
    pub fn new(database_name: impl Into<String>, object_store_name: impl Into<String>) -> Self {
        Self {
            database_name: database_name.into(),
            object_store_name: object_store_name.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
        }
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum ClearObjectStoreMethod {
    #[serde(rename = "IndexedDB.clearObjectStore")]
    ClearObjectStore,
}
#[doc = "Clears all entries from an object store.\n[clearObjectStore](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-clearObjectStore)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ClearObjectStore {
    pub method: ClearObjectStoreMethod,
    pub params: ClearObjectStoreParams,
}
impl ClearObjectStore {
    pub const IDENTIFIER: &'static str = "IndexedDB.clearObjectStore";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for ClearObjectStore {
    type Result = super::results::ClearObjectStoreResult;
}
#[doc = "Deletes a database.\n[deleteDatabase](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-deleteDatabase)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DeleteDatabaseParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[doc = "Database name."]
    #[serde(rename = "databaseName")]
    pub database_name: String,
}
impl DeleteDatabaseParams {
    pub fn new(database_name: impl Into<String>) -> Self {
        Self {
            database_name: database_name.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
        }
    }
}
impl<T: Into<String>> From<T> for DeleteDatabaseParams {
    fn from(url: T) -> Self {
        DeleteDatabaseParams::new(url)
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum DeleteDatabaseMethod {
    #[serde(rename = "IndexedDB.deleteDatabase")]
    DeleteDatabase,
}
#[doc = "Deletes a database.\n[deleteDatabase](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-deleteDatabase)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DeleteDatabase {
    pub method: DeleteDatabaseMethod,
    pub params: DeleteDatabaseParams,
}
impl DeleteDatabase {
    pub const IDENTIFIER: &'static str = "IndexedDB.deleteDatabase";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for DeleteDatabase {
    type Result = super::results::DeleteDatabaseResult;
}
#[doc = "Delete a range of entries from an object store\n[deleteObjectStoreEntries](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-deleteObjectStoreEntries)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DeleteObjectStoreEntriesParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[serde(rename = "databaseName")]
    pub database_name: String,
    #[serde(rename = "objectStoreName")]
    pub object_store_name: String,
    #[doc = "Range of entry keys to delete"]
    #[serde(rename = "keyRange")]
    pub key_range: super::types::KeyRange,
}
impl DeleteObjectStoreEntriesParams {
    pub fn new(
        database_name: impl Into<String>,
        object_store_name: impl Into<String>,
        key_range: impl Into<super::types::KeyRange>,
    ) -> Self {
        Self {
            database_name: database_name.into(),
            object_store_name: object_store_name.into(),
            key_range: key_range.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
        }
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum DeleteObjectStoreEntriesMethod {
    #[serde(rename = "IndexedDB.deleteObjectStoreEntries")]
    DeleteObjectStoreEntries,
}
#[doc = "Delete a range of entries from an object store\n[deleteObjectStoreEntries](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-deleteObjectStoreEntries)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DeleteObjectStoreEntries {
    pub method: DeleteObjectStoreEntriesMethod,
    pub params: DeleteObjectStoreEntriesParams,
}
impl DeleteObjectStoreEntries {
    pub const IDENTIFIER: &'static str = "IndexedDB.deleteObjectStoreEntries";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for DeleteObjectStoreEntries {
    type Result = super::results::DeleteObjectStoreEntriesResult;
}
#[doc = "Disables events from backend.\n[disable](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-disable)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DisableParams {}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum DisableMethod {
    #[serde(rename = "IndexedDB.disable")]
    Disable,
}
#[doc = "Disables events from backend.\n[disable](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-disable)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Disable {
    pub method: DisableMethod,
    pub params: DisableParams,
}
impl Disable {
    pub const IDENTIFIER: &'static str = "IndexedDB.disable";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for Disable {
    type Result = super::results::DisableResult;
}
#[doc = "Enables events from backend.\n[enable](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-enable)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct EnableParams {}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum EnableMethod {
    #[serde(rename = "IndexedDB.enable")]
    Enable,
}
#[doc = "Enables events from backend.\n[enable](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-enable)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Enable {
    pub method: EnableMethod,
    pub params: EnableParams,
}
impl Enable {
    pub const IDENTIFIER: &'static str = "IndexedDB.enable";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for Enable {
    type Result = super::results::EnableResult;
}
#[doc = "Requests data from object store or index.\n[requestData](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestData)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RequestDataParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[doc = "Database name."]
    #[serde(rename = "databaseName")]
    pub database_name: String,
    #[doc = "Object store name."]
    #[serde(rename = "objectStoreName")]
    pub object_store_name: String,
    #[doc = "Index name. If not specified, it performs an object store data request."]
    #[serde(rename = "indexName")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub index_name: Option<String>,
    #[doc = "Number of records to skip."]
    #[serde(rename = "skipCount")]
    pub skip_count: i64,
    #[doc = "Number of records to fetch."]
    #[serde(rename = "pageSize")]
    pub page_size: i64,
    #[doc = "Key range."]
    #[serde(rename = "keyRange")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub key_range: Option<super::types::KeyRange>,
}
impl RequestDataParams {
    pub fn new(
        database_name: impl Into<String>,
        object_store_name: impl Into<String>,
        skip_count: impl Into<i64>,
        page_size: impl Into<i64>,
    ) -> Self {
        Self {
            database_name: database_name.into(),
            object_store_name: object_store_name.into(),
            skip_count: skip_count.into(),
            page_size: page_size.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
            index_name: None,
            key_range: None,
        }
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum RequestDataMethod {
    #[serde(rename = "IndexedDB.requestData")]
    RequestData,
}
#[doc = "Requests data from object store or index.\n[requestData](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestData)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RequestData {
    pub method: RequestDataMethod,
    pub params: RequestDataParams,
}
impl RequestData {
    pub const IDENTIFIER: &'static str = "IndexedDB.requestData";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for RequestData {
    type Result = super::results::RequestDataResult;
}
#[doc = "Gets metadata of an object store.\n[getMetadata](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-getMetadata)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct GetMetadataParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[doc = "Database name."]
    #[serde(rename = "databaseName")]
    pub database_name: String,
    #[doc = "Object store name."]
    #[serde(rename = "objectStoreName")]
    pub object_store_name: String,
}
impl GetMetadataParams {
    pub fn new(database_name: impl Into<String>, object_store_name: impl Into<String>) -> Self {
        Self {
            database_name: database_name.into(),
            object_store_name: object_store_name.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
        }
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum GetMetadataMethod {
    #[serde(rename = "IndexedDB.getMetadata")]
    GetMetadata,
}
#[doc = "Gets metadata of an object store.\n[getMetadata](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-getMetadata)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct GetMetadata {
    pub method: GetMetadataMethod,
    pub params: GetMetadataParams,
}
impl GetMetadata {
    pub const IDENTIFIER: &'static str = "IndexedDB.getMetadata";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for GetMetadata {
    type Result = super::results::GetMetadataResult;
}
#[doc = "Requests database with given name in given frame.\n[requestDatabase](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestDatabase)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RequestDatabaseParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
    #[doc = "Database name."]
    #[serde(rename = "databaseName")]
    pub database_name: String,
}
impl RequestDatabaseParams {
    pub fn new(database_name: impl Into<String>) -> Self {
        Self {
            database_name: database_name.into(),
            security_origin: None,
            storage_key: None,
            storage_bucket: None,
        }
    }
}
impl<T: Into<String>> From<T> for RequestDatabaseParams {
    fn from(url: T) -> Self {
        RequestDatabaseParams::new(url)
    }
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum RequestDatabaseMethod {
    #[serde(rename = "IndexedDB.requestDatabase")]
    RequestDatabase,
}
#[doc = "Requests database with given name in given frame.\n[requestDatabase](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestDatabase)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RequestDatabase {
    pub method: RequestDatabaseMethod,
    pub params: RequestDatabaseParams,
}
impl RequestDatabase {
    pub const IDENTIFIER: &'static str = "IndexedDB.requestDatabase";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for RequestDatabase {
    type Result = super::results::RequestDatabaseResult;
}
#[doc = "Requests database names for given security origin.\n[requestDatabaseNames](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestDatabaseNames)"]
#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
pub struct RequestDatabaseNamesParams {
    #[doc = "At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.\nSecurity origin."]
    #[serde(rename = "securityOrigin")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub security_origin: Option<String>,
    #[doc = "Storage key."]
    #[serde(rename = "storageKey")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_key: Option<String>,
    #[doc = "Storage bucket. If not specified, it uses the default bucket."]
    #[serde(rename = "storageBucket")]
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub storage_bucket: Option<crate::browser_protocol::storage::types::StorageBucket>,
}
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum RequestDatabaseNamesMethod {
    #[serde(rename = "IndexedDB.requestDatabaseNames")]
    RequestDatabaseNames,
}
#[doc = "Requests database names for given security origin.\n[requestDatabaseNames](https://chromedevtools.github.io/devtools-protocol/tot/IndexedDB/#method-requestDatabaseNames)"]
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct RequestDatabaseNames {
    pub method: RequestDatabaseNamesMethod,
    pub params: RequestDatabaseNamesParams,
}
impl RequestDatabaseNames {
    pub const IDENTIFIER: &'static str = "IndexedDB.requestDatabaseNames";
    pub fn identifier(&self) -> &'static str {
        Self::IDENTIFIER
    }
}
impl crate::CommandResult for RequestDatabaseNames {
    type Result = super::results::RequestDatabaseNamesResult;
}
group_enum ! (IndexedDbCommands { ClearObjectStore (ClearObjectStore) , DeleteDatabase (DeleteDatabase) , DeleteObjectStoreEntries (DeleteObjectStoreEntries) , Disable (Disable) , Enable (Enable) , RequestData (RequestData) , GetMetadata (GetMetadata) , RequestDatabase (RequestDatabase) , RequestDatabaseNames (RequestDatabaseNames) } + identifiable);