Skip to main content

rustenium_cdp_definitions/browser_protocol/audits/
commands.rs

1use serde::{Deserialize, Serialize};
2#[doc = "Returns the response body and size if it were re-encoded with the specified settings. Only\napplies to images.\n[getEncodedResponse](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-getEncodedResponse)"]
3#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
4pub struct GetEncodedResponseParams {
5    #[doc = "Identifier of the network request to get content for."]
6    #[serde(rename = "requestId")]
7    pub request_id: crate::browser_protocol::network::types::RequestId,
8    #[doc = "The encoding to use."]
9    #[serde(rename = "encoding")]
10    pub encoding: GetEncodedResponseEncoding,
11    #[doc = "The quality of the encoding (0-1). (defaults to 1)"]
12    #[serde(rename = "quality")]
13    #[serde(skip_serializing_if = "Option::is_none")]
14    #[serde(default)]
15    pub quality: Option<f64>,
16    #[doc = "Whether to only return the size information (defaults to false)."]
17    #[serde(rename = "sizeOnly")]
18    #[serde(skip_serializing_if = "Option::is_none")]
19    #[serde(default)]
20    pub size_only: Option<bool>,
21}
22#[doc = "The encoding to use."]
23#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
24pub enum GetEncodedResponseEncoding {
25    #[serde(rename = "webp")]
26    Webp,
27    #[serde(rename = "jpeg")]
28    Jpeg,
29    #[serde(rename = "png")]
30    Png,
31}
32impl GetEncodedResponseParams {
33    pub fn new(
34        request_id: impl Into<crate::browser_protocol::network::types::RequestId>,
35        encoding: impl Into<GetEncodedResponseEncoding>,
36    ) -> Self {
37        Self {
38            request_id: request_id.into(),
39            encoding: encoding.into(),
40            quality: None,
41            size_only: None,
42        }
43    }
44}
45#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
46pub enum GetEncodedResponseMethod {
47    #[serde(rename = "Audits.getEncodedResponse")]
48    GetEncodedResponse,
49}
50#[doc = "Returns the response body and size if it were re-encoded with the specified settings. Only\napplies to images.\n[getEncodedResponse](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-getEncodedResponse)"]
51#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
52pub struct GetEncodedResponse {
53    pub method: GetEncodedResponseMethod,
54    pub params: GetEncodedResponseParams,
55}
56impl GetEncodedResponse {
57    pub const IDENTIFIER: &'static str = "Audits.getEncodedResponse";
58    pub fn identifier(&self) -> &'static str {
59        Self::IDENTIFIER
60    }
61}
62impl crate::CommandResult for GetEncodedResponse {
63    type Result = super::results::GetEncodedResponseResult;
64}
65#[doc = "Disables issues domain, prevents further issues from being reported to the client.\n[disable](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-disable)"]
66#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
67pub struct DisableParams {}
68#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
69pub enum DisableMethod {
70    #[serde(rename = "Audits.disable")]
71    Disable,
72}
73#[doc = "Disables issues domain, prevents further issues from being reported to the client.\n[disable](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-disable)"]
74#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
75pub struct Disable {
76    pub method: DisableMethod,
77    pub params: DisableParams,
78}
79impl Disable {
80    pub const IDENTIFIER: &'static str = "Audits.disable";
81    pub fn identifier(&self) -> &'static str {
82        Self::IDENTIFIER
83    }
84}
85impl crate::CommandResult for Disable {
86    type Result = super::results::DisableResult;
87}
88#[doc = "Enables issues domain, sends the issues collected so far to the client by means of the\n`issueAdded` event.\n[enable](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-enable)"]
89#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
90pub struct EnableParams {}
91#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
92pub enum EnableMethod {
93    #[serde(rename = "Audits.enable")]
94    Enable,
95}
96#[doc = "Enables issues domain, sends the issues collected so far to the client by means of the\n`issueAdded` event.\n[enable](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-enable)"]
97#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
98pub struct Enable {
99    pub method: EnableMethod,
100    pub params: EnableParams,
101}
102impl Enable {
103    pub const IDENTIFIER: &'static str = "Audits.enable";
104    pub fn identifier(&self) -> &'static str {
105        Self::IDENTIFIER
106    }
107}
108impl crate::CommandResult for Enable {
109    type Result = super::results::EnableResult;
110}
111#[doc = "Runs the contrast check for the target page. Found issues are reported\nusing Audits.issueAdded event.\n[checkContrast](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-checkContrast)"]
112#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize)]
113pub struct CheckContrastParams {
114    #[doc = "Whether to report WCAG AAA level issues. Default is false."]
115    #[serde(rename = "reportAAA")]
116    #[serde(skip_serializing_if = "Option::is_none")]
117    #[serde(default)]
118    pub report_aaa: Option<bool>,
119}
120#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
121pub enum CheckContrastMethod {
122    #[serde(rename = "Audits.checkContrast")]
123    CheckContrast,
124}
125#[doc = "Runs the contrast check for the target page. Found issues are reported\nusing Audits.issueAdded event.\n[checkContrast](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-checkContrast)"]
126#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
127pub struct CheckContrast {
128    pub method: CheckContrastMethod,
129    pub params: CheckContrastParams,
130}
131impl CheckContrast {
132    pub const IDENTIFIER: &'static str = "Audits.checkContrast";
133    pub fn identifier(&self) -> &'static str {
134        Self::IDENTIFIER
135    }
136}
137impl crate::CommandResult for CheckContrast {
138    type Result = super::results::CheckContrastResult;
139}
140#[doc = "Runs the form issues check for the target page. Found issues are reported\nusing Audits.issueAdded event.\n[checkFormsIssues](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-checkFormsIssues)"]
141#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
142pub struct CheckFormsIssuesParams {}
143#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
144pub enum CheckFormsIssuesMethod {
145    #[serde(rename = "Audits.checkFormsIssues")]
146    CheckFormsIssues,
147}
148#[doc = "Runs the form issues check for the target page. Found issues are reported\nusing Audits.issueAdded event.\n[checkFormsIssues](https://chromedevtools.github.io/devtools-protocol/tot/Audits/#method-checkFormsIssues)"]
149#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
150pub struct CheckFormsIssues {
151    pub method: CheckFormsIssuesMethod,
152    pub params: CheckFormsIssuesParams,
153}
154impl CheckFormsIssues {
155    pub const IDENTIFIER: &'static str = "Audits.checkFormsIssues";
156    pub fn identifier(&self) -> &'static str {
157        Self::IDENTIFIER
158    }
159}
160impl crate::CommandResult for CheckFormsIssues {
161    type Result = super::results::CheckFormsIssuesResult;
162}
163group_enum ! (AuditsCommands { GetEncodedResponse (GetEncodedResponse) , Disable (Disable) , Enable (Enable) , CheckContrast (CheckContrast) , CheckFormsIssues (CheckFormsIssues) } + identifiable);