### Install Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/index.html Installs the given manifest identity, optionally using the provided install URL or bundle URL. This command is used to add a PWA to the system. ```APIDOC ## Install ### Description Installs the given manifest identity, optionally using the provided install URL or bundle URL. This command is used to add a PWA to the system. ### Method Not specified (likely POST based on context) ### Endpoint Not specified ### Parameters #### Request Body - **manifestId** (string) - Required - The manifest ID of the web app. - **installUrlOrBundleUrl** (string) - Optional - The URL for installation. ``` -------------------------------- ### Start Screencast Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/index.html Starts sending each frame using the `screencastFrame` event. ```APIDOC ## POST /startScreencast ### Description Starts sending each frame using the `screencastFrame` event. ### Method POST ### Endpoint /startScreencast ### Parameters #### Query Parameters - **format** (StartScreencastFormat) - Optional - Image compression format. ### Response #### Success Response (200) (No specific response fields documented) ``` -------------------------------- ### Set Start URL Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.WebAppManifestBuilder.html Use this method to set the start URL for the web application. ```rust pub fn start_url(self, start_url: impl Into) -> WebAppManifestBuilder ``` -------------------------------- ### StartDesktopMirroringParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting desktop mirroring. ```APIDOC ## StartDesktopMirroringParams ### Description Starts mirroring the desktop. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting desktop mirroring. Specific fields are not detailed in the source. ### Request Example ```json { "example": "desktop mirroring parameters" } ``` ### Response Success response indicates desktop mirroring has started. Specific fields are not detailed in the source. ``` -------------------------------- ### Profiler.StartParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting the profiler. ```APIDOC ## Profiler.StartParams ### Description Starts the JavaScript profiler to collect performance metrics. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting the profiler. Specific fields are not detailed in the source. ### Request Example ```json { "example": "profiler start parameters" } ``` ### Response Success response indicates the profiler has started. Specific fields are not detailed in the source. ``` -------------------------------- ### Setting Push Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `push_start` method to specify the time when the push started. This is a builder method for ResourceTiming. ```rust pub fn push_start(self, push_start: impl Into) -> ResourceTimingBuilder ``` -------------------------------- ### StartSampling Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/memory/index.html Start collecting native memory profile. ```APIDOC ## StartSampling ### Description Start collecting native memory profile. ### Method `startSampling` ### Parameters None ### Response #### Success Response (200) (No specific fields documented) ``` -------------------------------- ### StartDesktopMirroringParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Starts desktop mirroring. This command takes `StartDesktopMirroringParams` and returns `StartDesktopMirroringReturns`. ```APIDOC ## StartDesktopMirroringParams ### Description Starts desktop mirroring. ### Method (Not specified, assumed to be part of a command execution) ### Endpoint (Not specified) ### Parameters (Not specified) ### Request Example (Not specified) ### Response #### Success Response - **Response** (StartDesktopMirroringReturns) - The return type for the command. ``` -------------------------------- ### Tracing.StartParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting tracing. ```APIDOC ## Tracing.StartParams ### Description Starts collecting trace events from the browser. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting tracing. Specific fields are not detailed in the source. ### Request Example ```json { "example": "tracing start parameters" } ``` ### Response Success response indicates tracing has started. Specific fields are not detailed in the source. ``` -------------------------------- ### Setting SSL Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `ssl_start` method to record the time when the SSL handshake started. This is a fluent setter for ResourceTimingBuilder. ```rust pub fn ssl_start(self, ssl_start: impl Into) -> ResourceTimingBuilder ``` -------------------------------- ### StartObservingParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Starts observing. This command takes `StartObservingParams` and returns `StartObservingReturns`. ```APIDOC ## StartObservingParams ### Description Starts observing. ### Method (Not specified, assumed to be part of a command execution) ### Endpoint (Not specified) ### Parameters (Not specified) ### Request Example (Not specified) ### Response #### Success Response - **Response** (StartObservingReturns) - The return type for the command. ``` -------------------------------- ### LoadUnpacked Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/extensions/index.html Installs an unpacked extension from the filesystem. ```APIDOC ## POST /extensions/loadUnpacked ### Description Installs an unpacked extension from the filesystem similar to –load-extension CLI flags. Returns extension ID once the extension has been installed. Available if the client is connected using the –remote-debugging-pipe flag and the –enable-unsafe-extension-debugging flag is set. ### Method POST ### Endpoint /extensions/loadUnpacked ### Parameters #### Request Body - **path** (string) - Required - The path to the unpacked extension directory. - **allowFileAccess** (boolean) - Optional - Whether to allow file access for the extension. - **incognito** (boolean) - Optional - Whether to load the extension in incognito mode. - **forceDevToolsVisible** (boolean) - Optional - Whether to force developer tools to be visible for the extension. - **disableRPCMessageChannel** (boolean) - Optional - Whether to disable the RPC message channel for the extension. ### Response #### Success Response (200) - **extensionId** (string) - The ID of the installed extension. ``` -------------------------------- ### Set Start Step for ReplaySnapshotParamsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/layer_tree/struct.ReplaySnapshotParamsBuilder.html Sets the starting step for the replay range. Use this to define the beginning of the snapshot sequence to replay. ```rust pub fn from_step(self, from_step: impl Into) -> ReplaySnapshotParamsBuilder ``` -------------------------------- ### Launch Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/index.html Launches the installed web app. An optional URL can be provided to launch a specific page within the web app instead of the default start URL. Returns a Target.TargetID for the launched page. ```APIDOC ## Launch ### Description Launches the installed web app. An optional URL can be provided to launch a specific page within the web app instead of the default start URL. Returns a Target.TargetID for the launched page. ### Method Not specified (likely POST based on context) ### Endpoint Not specified ### Parameters #### Request Body - **manifestId** (string) - Required - The manifest ID of the web app. - **url** (string) - Optional - The URL to launch within the web app. ``` -------------------------------- ### InstallParamsBuilder Methods Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallParamsBuilder.html Methods available on the InstallParamsBuilder for setting installation parameters. ```APIDOC ## InstallParamsBuilder ### Description Used to construct `InstallParams` for PWA installations. ### Methods #### `manifest_id(self, manifest_id: impl Into) -> InstallParamsBuilder` Sets the manifest ID for the PWA. #### `install_url_or_bundle_url(self, install_url_or_bundle_url: impl Into) -> InstallParamsBuilder` Sets the install URL or bundle URL for the PWA. #### `build(self) -> Result` Builds the `InstallParams` object. Returns a `Result` which is `Ok(InstallParams)` on success or `Err(String)` if there was an error. ``` -------------------------------- ### Set Install URL or Bundle URL for InstallParamsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallParamsBuilder.html Sets the installation URL or bundle URL for the PWA. This method consumes the builder and returns it, enabling method chaining. ```rust pub fn install_url_or_bundle_url( self, install_url_or_bundle_url: impl Into, ) -> InstallParamsBuilder ``` -------------------------------- ### StartRuleUsageTrackingParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting rule usage tracking. ```APIDOC ## StartRuleUsageTrackingParams ### Description Starts tracking the usage of rules. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting rule usage tracking. Specific fields are not detailed in the source. ### Request Example ```json { "example": "rule usage tracking start parameters" } ``` ### Response Success response indicates rule usage tracking has started. Specific fields are not detailed in the source. ``` -------------------------------- ### StartScreencastParams Command Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html This command is used to start screen casting. It returns a StartScreencastReturns object. ```APIDOC ## impl Command for StartScreencastParams ### Description Starts screen casting. ### Response #### Success Response - **Response** (StartScreencastReturns) - The result of the command. ``` -------------------------------- ### InstallParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Represents a command to install something. The response type is InstallReturns. ```APIDOC ## InstallParams ### Description Installs a specified item or component. ### Response #### Success Response - **Response** (InstallReturns) - The result of the command. ``` -------------------------------- ### Setting Replacement Start for Composition Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/input/struct.ImeSetCompositionParamsBuilder.html Use the `replacement_start` method to define the starting index for text replacement within the composition. Accepts any type convertible to i64. ```rust pub fn replacement_start( self, replacement_start: impl Into, ) -> ImeSetCompositionParamsBuilder ``` -------------------------------- ### startInspectQuerySelector Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/dom/index.html Starts the inspect query selector. ```APIDOC ## startInspectQuerySelector ### Description Starts the inspect query selector. ### Method POST ### Endpoint /session/{sessionId}/dom/startInspectQuerySelector ### Parameters #### Request Body - **selector** (string) - Required - The CSS selector to inspect. ### Response #### Success Response (200) {} ``` -------------------------------- ### Default GetSecurityIsolationStatusReturnsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.GetSecurityIsolationStatusReturnsBuilder.html Returns the default value for GetSecurityIsolationStatusReturnsBuilder. Use this to get a starting point. ```rust fn default() -> GetSecurityIsolationStatusReturnsBuilder ``` -------------------------------- ### Setting Proxy Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `proxy_start` method to specify the time when the proxy connection started. This method is part of the ResourceTimingBuilder. ```rust pub fn proxy_start(self, proxy_start: impl Into) -> ResourceTimingBuilder ``` -------------------------------- ### EnableReturns Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/web_audio/struct.EnableReturns.html Enables the WebAudio domain and starts sending context lifetime events. ```APIDOC ## Struct EnableReturns ### Description Enables the WebAudio domain and starts sending context lifetime events. ### Usage This struct is typically used as a return type for an operation that enables the WebAudio domain. It does not contain any fields, indicating that the enablement is a success signal itself. ### Fields This struct has no fields. ``` -------------------------------- ### Default NavigationEntryBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.NavigationEntryBuilder.html Provides a default instance of NavigationEntryBuilder. Use this to get a starting point for building an entry. ```rust fn default() -> NavigationEntryBuilder ``` -------------------------------- ### Get the default GetPlatformFontsForNodeReturnsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.GetPlatformFontsForNodeReturnsBuilder.html Returns a new builder with default values. This is the starting point for creating a new builder. ```rust fn default() -> GetPlatformFontsForNodeReturnsBuilder ``` -------------------------------- ### Start Desktop Mirroring Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/index.html Initiates mirroring of the entire desktop to a specified Cast sink. ```APIDOC ## Start Desktop Mirroring ### Description Starts mirroring the desktop to the sink. ### Method `startDesktopMirroring` ### Parameters #### Request Body - **sinkName** (string) - Required - The name of the sink to cast to. ### Response (No specific response fields documented, typically an empty object on success) ``` -------------------------------- ### StartPreciseCoverageParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Starts precise coverage. This command takes `StartPreciseCoverageParams` and returns `StartPreciseCoverageReturns`. ```APIDOC ## StartPreciseCoverageParams ### Description Starts precise coverage. ### Method (Not specified, assumed to be part of a command execution) ### Endpoint (Not specified) ### Parameters (Not specified) ### Request Example (Not specified) ### Response #### Success Response - **Response** (StartPreciseCoverageReturns) - The return type for the command. ``` -------------------------------- ### Setting Selection Start for Composition Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/input/struct.ImeSetCompositionParamsBuilder.html Use the `selection_start` method to specify the starting index of the selection within the composition text. Accepts any type convertible to i64. ```rust pub fn selection_start( self, selection_start: impl Into, ) -> ImeSetCompositionParamsBuilder ``` -------------------------------- ### chromiumoxide::cdp::browser_protocol::tracing::StartParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Starts tracing. This command takes `chromiumoxide::cdp::browser_protocol::tracing::StartParams` and returns `StartReturns`. ```APIDOC ## chromiumoxide::cdp::browser_protocol::tracing::StartParams ### Description Starts tracing. ### Method (Not specified, assumed to be part of a command execution) ### Endpoint (Not specified) ### Parameters (Not specified) ### Request Example (Not specified) ### Response #### Success Response - **Response** (StartReturns) - The return type for the command. ``` -------------------------------- ### Default PropertyDescriptorBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/runtime/struct.PropertyDescriptorBuilder.html Provides a default PropertyDescriptorBuilder instance, useful for starting a new descriptor construction with minimal setup. ```rust fn default() -> PropertyDescriptorBuilder ``` -------------------------------- ### Default WebSocketResponseBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.WebSocketResponseBuilder.html The `default` method returns a new `WebSocketResponseBuilder` initialized with default values. This is the standard way to get a starting builder instance. ```rust fn default() -> WebSocketResponseBuilder ``` -------------------------------- ### InstallParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallParams.html Represents the parameters for installing a Progressive Web App (PWA). ```APIDOC ## InstallParams Represents the parameters for installing a Progressive Web App (PWA). ### Methods #### `new(manifest_id: impl Into) -> InstallParams` Creates a new `InstallParams` instance with the given manifest ID. #### `builder() -> InstallParamsBuilder` Returns a builder for constructing `InstallParams`. #### `IDENTIFIER: &'static str = "PWA.install"` The static identifier for the PWA installation command. ``` -------------------------------- ### StartPreciseCoverageParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting precise coverage. ```APIDOC ## StartPreciseCoverageParams ### Description Starts collecting precise code coverage information. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting precise coverage. Specific fields are not detailed in the source. ### Request Example ```json { "example": "precise coverage start parameters" } ``` ### Response Success response indicates precise coverage collection has started. Specific fields are not detailed in the source. ``` -------------------------------- ### Default ExceptionDetailsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/runtime/struct.ExceptionDetailsBuilder.html The `default` function creates a new ExceptionDetailsBuilder with default values. This is the standard way to get a starting point for building an ExceptionDetails object. ```rust fn default() -> ExceptionDetailsBuilder ``` -------------------------------- ### StartScreencastParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.StartScreencastParams.html Starts sending each frame using the `screencastFrame` event. ```APIDOC ## Struct StartScreencastParams ### Description Starts sending each frame using the `screencastFrame` event. startScreencast ### Fields - **format** (`Option`) - Image compression format. - **quality** (`Option`) - Compression quality from range [0..100]. - **max_width** (`Option`) - Maximum screenshot width. - **max_height** (`Option`) - Maximum screenshot height. - **every_nth_frame** (`Option`) - Send every n-th frame. ### Method `Page.startScreencast` ``` -------------------------------- ### EventFrameStartedNavigating Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.EventFrameStartedNavigating.html Represents the Page.frameStartedNavigating event. Fired when a navigation starts. This event is fired for both renderer-initiated and browser-initiated navigations. For renderer-initiated navigations, the event is fired after `frameRequestedNavigation`. Navigation may still be cancelled after the event is issued. Multiple events can be fired for a single navigation, for example, when a same-document navigation becomes a cross-document navigation (such as in the case of a frameset). ```APIDOC ## EventFrameStartedNavigating ### Description Fired when a navigation starts. This event is fired for both renderer-initiated and browser-initiated navigations. For renderer-initiated navigations, the event is fired after `frameRequestedNavigation`. Navigation may still be cancelled after the event is issued. Multiple events can be fired for a single navigation, for example, when a same-document navigation becomes a cross-document navigation (such as in the case of a frameset). ### Fields * **frame_id** (FrameId) - ID of the frame that is being navigated. * **url** (String) - The URL the navigation started with. The final URL can be different. * **loader_id** (LoaderId) - Loader identifier. Even though it is present in case of same-document navigation, the previously committed loaderId would not change unless the navigation changes from a same-document to a cross-document navigation. * **navigation_type** (FrameStartedNavigatingNavigationType) - The type of navigation that started. ``` -------------------------------- ### chromiumoxide::cdp::js_protocol::profiler::StartParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html Starts the JavaScript profiler. This command takes `chromiumoxide::cdp::js_protocol::profiler::StartParams` and returns `StartReturns`. ```APIDOC ## chromiumoxide::cdp::js_protocol::profiler::StartParams ### Description Starts the JavaScript profiler. ### Method (Not specified, assumed to be part of a command execution) ### Endpoint (Not specified) ### Parameters (Not specified) ### Request Example (Not specified) ### Response #### Success Response - **Response** (StartReturns) - The return type for the command. ``` -------------------------------- ### Setting Start Position for TextBoxSnapshotBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/dom_snapshot/struct.TextBoxSnapshotBuilder.html Configures the starting position for the TextBoxSnapshotBuilder. Use this method to specify a single start index. ```rust pub fn start(self, start: impl Into) -> TextBoxSnapshotBuilder ``` -------------------------------- ### StartObservingParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting observation. ```APIDOC ## StartObservingParams ### Description Starts observing a particular target or event. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting observation. Specific fields are not detailed in the source. ### Request Example ```json { "example": "observation parameters" } ``` ### Response Success response indicates observation has started. Specific fields are not detailed in the source. ``` -------------------------------- ### EnableReturns Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.EnableReturns.html Starts observing for sinks that can be used for tab mirroring, and if set, sinks compatible with |presentationUrl| as well. When sinks are found, a |sinksUpdated| event is fired. Also starts observing for issue messages. When an issue is added or removed, an |issueUpdated| event is fired. ```APIDOC ## Struct EnableReturns ### Summary ```rust pub struct EnableReturns {} ``` ### Description Starts observing for sinks that can be used for tab mirroring, and if set, sinks compatible with |presentationUrl| as well. When sinks are found, a |sinksUpdated| event is fired. Also starts observing for issue messages. When an issue is added or removed, an |issueUpdated| event is fired. ``` -------------------------------- ### StartParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/tracing/struct.StartParams.html Represents the parameters for the Tracing.start command. ```APIDOC ## Tracing.start ### Description Starts tracing, no more than one tracing is active. ### Method POST ### Endpoint /json/protocol/browser/Tracing.start ### Parameters #### Request Body - **categories** (string) - Optional - A list of comma separated strings of trace categories to include. If omitted, the default categories will be used. - **options** (object) - Optional - Options for the trace. - **trace_buffer_size** (number) - Optional - Size of the trace buffer. - **stream_compression** (boolean) - Optional - Whether to compress the trace stream. ### Request Example ```json { "categories": "devtools.timeline, nặng", "options": { "trace_buffer_size": 100000, "stream_compression": true } } ``` ### Response #### Success Response (200) This method does not return a response. ``` -------------------------------- ### Event Animation Started Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Method.html Represents an animation being started. ```APIDOC ## impl Method for EventAnimationStarted ### Description Represents an animation being started. ### Method Not specified (likely an event notification) ### Endpoint Not specified ### Parameters None explicitly listed. ### Request Example ```json { "example": "No specific request body example provided" } ``` ### Response #### Success Response (200) - None explicitly documented. #### Response Example ```json { "example": "No specific response example provided" } ``` ``` -------------------------------- ### Building StartDesktopMirroringParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.StartDesktopMirroringParamsBuilder.html Call the `build` method on the builder to construct the final `StartDesktopMirroringParams`. This method returns a `Result` which is either the parameters or an error string. ```rust pub fn build(self) -> Result ``` -------------------------------- ### Start Violations Report Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/log/index.html Starts reporting performance violations. ```APIDOC ## POST /json/protocol/Log.startViolationsReport ### Description Initiates the reporting of performance violations. Requires a `ViolationSetting` configuration. ### Method POST ### Endpoint /json/protocol/Log.startViolationsReport ### Parameters #### Request Body - **violationSettings** (array of `ViolationSetting`) - Required - Configuration settings for violations to report. ### Request Example ```json { "violationSettings": [ { "name": "longTask", "threshold": 100 } ] } ``` ### Response #### Success Response (200) - **None** #### Response Example ```json {} ``` ``` -------------------------------- ### goto Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/page/struct.Page.html Navigates directly to the given URL and resolves once the URL is fully loaded. ```APIDOC ## goto ### Description Navigate directly to the given URL. This resolves directly after the requested URL is fully loaded. ### Method async fn goto(&self, params: impl Into) -> Result<&Self> ``` -------------------------------- ### HeapProfiler.StartSamplingParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting heap sampling. ```APIDOC ## HeapProfiler.StartSamplingParams ### Description Starts sampling the JavaScript heap. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting heap sampling. Specific fields are not detailed in the source. ### Request Example ```json { "example": "heap profiler start sampling parameters" } ``` ### Response Success response indicates heap sampling has started. Specific fields are not detailed in the source. ``` -------------------------------- ### LaunchReturns::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.LaunchReturns.html Constructor for creating a new LaunchReturns instance. ```APIDOC ### impl LaunchReturns #### pub fn new(target_id: impl Into) -> LaunchReturns Creates a new `LaunchReturns` with the given target ID. ``` -------------------------------- ### MediaQuery::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.MediaQuery.html Constructs a new `MediaQuery` instance. ```APIDOC ## pub fn new( expressions: Vec, active: impl Into, ) -> MediaQuery Constructs a new `MediaQuery` instance with the given expressions and active status. ``` -------------------------------- ### Get TypeId of EvaluationResult Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/js/struct.EvaluationResult.html Gets the TypeId of the EvaluationResult. This is part of the Any trait implementation. ```rust fn type_id(&self) -> TypeId> ``` -------------------------------- ### Get TypeId of Command Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/async_process/struct.Command.html The `Any` trait implementation provides a `type_id` method to get the `TypeId` of the `Command`. ```rust fn type_id(&self) -> TypeId ``` -------------------------------- ### Event Affected By Starting Styles Flag Updated Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Method.html Represents a change in the 'affected by starting styles' flag. ```APIDOC ## impl Method for EventAffectedByStartingStylesFlagUpdated ### Description Represents a change in the 'affected by starting styles' flag. ### Method Not specified (likely an event notification) ### Endpoint Not specified ### Parameters None explicitly listed. ### Request Example ```json { "example": "No specific request body example provided" } ``` ### Response #### Success Response (200) - None explicitly documented. #### Response Example ```json { "example": "No specific response example provided" } ``` ``` -------------------------------- ### DevicePosture::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/emulation/struct.DevicePosture.html Constructor for creating a new DevicePosture instance. ```APIDOC ## impl DevicePosture ### pub fn new(type: impl Into) -> DevicePosture Creates a new DevicePosture. ``` -------------------------------- ### Setting Start Offset for CoverageRangeBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/profiler/struct.CoverageRangeBuilder.html Sets the start offset for a CoverageRange. Use this method when constructing a CoverageRangeBuilder. ```rust pub fn start_offset(self, start_offset: impl Into) -> CoverageRangeBuilder ``` -------------------------------- ### StartDesktopMirroringParams::new Constructor Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.StartDesktopMirroringParams.html Creates a new instance of StartDesktopMirroringParams. Accepts any type that can be converted into a String for the sink name. ```rust pub fn new(sink_name: impl Into) -> StartDesktopMirroringParams ``` -------------------------------- ### AnimationBuilder: Set Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/animation/struct.AnimationBuilder.html Sets the start time of the animation. This specifies when the animation should begin playing. ```rust pub fn start_time(self, start_time: impl Into) -> AnimationBuilder ``` -------------------------------- ### Setting Connection Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `connect_start` method to specify the time when the connection attempt began. This is a builder method for ResourceTiming. ```rust pub fn connect_start( self, connect_start: impl Into, ) -> ResourceTimingBuilder ``` -------------------------------- ### Set GUID for CancelDownloadParamsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/browser/struct.CancelDownloadParamsBuilder.html Sets the GUID for the download to be cancelled. This method is part of the builder pattern for CancelDownloadParams. ```rust pub fn guid(self, guid: impl Into) -> CancelDownloadParamsBuilder ``` -------------------------------- ### ScopeBuilder Start Location Setter Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/debugger/struct.ScopeBuilder.html Sets the starting location of the scope. This method is part of the builder pattern for ScopeBuilder. ```rust pub fn start_location(self, start_location: impl Into) -> ScopeBuilder ``` -------------------------------- ### LocationRangeBuilder Start Position Setter Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/debugger/struct.LocationRangeBuilder.html Sets the starting position for the LocationRange. This is useful for defining the beginning of a code segment. ```rust pub fn start(self, start: impl Into) -> LocationRangeBuilder ``` -------------------------------- ### Add Single Installability Error Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.GetInstallabilityErrorsReturnsBuilder.html Adds a single installability error to the builder. The error can be any type that can be converted into an InstallabilityError. ```rust pub fn installability_error( self, installability_error: impl Into, ) -> GetInstallabilityErrorsReturnsBuilder ``` -------------------------------- ### Start Tracing Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/tracing/index.html Starts trace events collection. This method initiates the tracing process, allowing you to capture performance data. ```APIDOC ## Start Tracing ### Description Starts trace events collection. ### Method `start` ### Parameters (No specific parameters documented for the start method itself, but configuration might be implied by `StartParams` and `TraceConfig` structs) ### Request Example (No explicit request example provided in source) ### Response #### Success Response `StartReturns` - Indicates successful initiation of tracing. #### Response Example (No explicit response example provided in source) ``` -------------------------------- ### Set Wait for Debugger on Start for AutoAttachRelatedParamsBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/target/struct.AutoAttachRelatedParamsBuilder.html Configures whether to wait for the debugger to start. Accepts any type that can be converted into a boolean. ```rust pub fn wait_for_debugger_on_start( self, wait_for_debugger_on_start: impl Into, ) -> AutoAttachRelatedParamsBuilder ``` -------------------------------- ### New LaunchFilesInAppReturns Instance Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.LaunchFilesInAppReturns.html Constructs a new LaunchFilesInAppReturns instance with the provided target IDs. Use this when you have a list of TargetIds to return. ```rust pub fn new(target_ids: Vec) -> LaunchFilesInAppReturns ``` -------------------------------- ### Building PartitioningBlobUrlIssueDetails Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/audits/struct.PartitioningBlobUrlIssueDetailsBuilder.html Builds and returns the PartitioningBlobUrlIssueDetails. Returns a Result which is either the details or an error String. ```rust pub fn build(self) -> Result ``` -------------------------------- ### Setting Start Offset for RuleUsageBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.RuleUsageBuilder.html Sets the starting offset for the CSS rule usage. Accepts any type that can be converted into an f64. ```rust pub fn start_offset(self, start_offset: impl Into) -> RuleUsageBuilder ``` -------------------------------- ### StartDesktopMirroringParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.StartDesktopMirroringParams.html Defines the parameters for the Cast.startDesktopMirroring command. This struct is used to specify the target sink for desktop mirroring. ```APIDOC ## Struct StartDesktopMirroringParams ### Description Parameters for starting desktop mirroring. ### Fields * `sink_name` (String) - The name of the sink to which the desktop will be mirrored. ``` -------------------------------- ### Set Start Column for CssStyleSheetHeaderBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.CssStyleSheetHeaderBuilder.html Set the starting column number of the stylesheet content. Accepts any type convertible to f64. ```rust pub fn start_column( self, start_column: impl Into, ) -> CssStyleSheetHeaderBuilder ``` -------------------------------- ### Building LaunchFilesInAppReturns Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.LaunchFilesInAppReturnsBuilder.html Constructs and returns the final LaunchFilesInAppReturns object. Returns a Result which is Ok on success or Err with a String message on failure. ```rust pub fn build(self) -> Result ``` -------------------------------- ### Set Start Line for CssStyleSheetHeaderBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.CssStyleSheetHeaderBuilder.html Set the starting line number of the stylesheet content. Accepts any type convertible to f64. ```rust pub fn start_line( self, start_line: impl Into, ) -> CssStyleSheetHeaderBuilder ``` -------------------------------- ### PrintToPdfReturns::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.PrintToPdfReturns.html Constructor for creating a new PrintToPdfReturns instance with binary data. ```APIDOC ### impl PrintToPdfReturns #### pub fn new(data: impl Into) -> PrintToPdfReturns Creates a new PrintToPdfReturns with the provided binary data. ``` -------------------------------- ### Setting Worker Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `worker_start` method to specify the time when the service worker started. This is a builder method for ResourceTiming. ```rust pub fn worker_start(self, worker_start: impl Into) -> ResourceTimingBuilder ``` -------------------------------- ### Setting DNS Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `dns_start` method to record the time when the DNS lookup began. This is a fluent setter for ResourceTimingBuilder. ```rust pub fn dns_start(self, dns_start: impl Into) -> ResourceTimingBuilder ``` -------------------------------- ### Building StorageBucketInfo Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/storage/struct.StorageBucketInfoBuilder.html Builds and returns a StorageBucketInfo object or an error string. ```rust pub fn build(self) -> Result ``` -------------------------------- ### Setting Start Offset for ViewOrScrollTimelineBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/animation/struct.ViewOrScrollTimelineBuilder.html Sets the starting offset for the animation timeline. This is useful for precise control over the animation's beginning. ```rust pub fn start_offset( self, start_offset: impl Into, ) -> ViewOrScrollTimelineBuilder ``` -------------------------------- ### Profiler.start Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/js_protocol/profiler/struct.StartParams.html The StartParams struct is used to configure and send the Profiler.start command to the Chromium DevTools Protocol. It has no configurable parameters and is used to initiate profiling. ```APIDOC ## Profiler.start ### Description Initiates the profiler to collect performance metrics. This command takes no arguments. ### Method POST ### Endpoint /json/protocol ### Request Body ```json { "id": "some_id", "method": "Profiler.start", "params": {} } ``` ### Response #### Success Response (200) This command does not return a specific response body upon success, indicating that the profiler has started. ### Response Example ```json { "id": "some_id", "result": {} } ``` ``` -------------------------------- ### Setting Worker Fetch Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `worker_fetch_start` method to record the time when the worker fetch started. This is a fluent setter for ResourceTimingBuilder. ```rust pub fn worker_fetch_start( self, worker_fetch_start: impl Into, ) -> ResourceTimingBuilder ``` -------------------------------- ### Setting Multiple Start Positions for TextBoxSnapshotBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/dom_snapshot/struct.TextBoxSnapshotBuilder.html Configures multiple starting positions for the TextBoxSnapshotBuilder. Accepts any type that can be converted into an iterator of i64 values. ```rust pub fn starts(self, starts: I) -> TextBoxSnapshotBuilder where I: IntoIterator, S: Into, ``` -------------------------------- ### EnableReturns Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/web_authn/struct.EnableReturns.html Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator. ```APIDOC ## Struct EnableReturns ### Description Enable the WebAuthn domain and start intercepting credential storage and retrieval with a virtual authenticator. ### Struct Definition ```rust pub struct EnableReturns {} ``` ### Usage This struct is typically used as a return type for an operation that enables the WebAuthn domain. It does not contain any fields, indicating a successful enablement. ### Associated Functions - `clone()`: Returns a duplicate of the value. - `clone_from()`: Performs copy-assignment from a source. - `fmt()`: Formats the value using the given formatter. - `default()`: Returns the default value for the type. - `deserialize()`: Deserializes the value from a Serde deserializer. - `eq()`: Tests for equality with another `EnableReturns` instance. - `ne()`: Tests for inequality with another `EnableReturns` instance. - `serialize()`: Serializes the value into a Serde serializer. ``` -------------------------------- ### StartViolationsReportParams Command Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html This command is used to start violations reporting. It returns a StartViolationsReportReturns object. ```APIDOC ## impl Command for StartViolationsReportParams ### Description Starts violations reporting. ### Response #### Success Response - **Response** (StartViolationsReportReturns) - The result of the command. ``` -------------------------------- ### Setting Start Character Index for InlineTextBoxBuilder Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/dom_snapshot/struct.InlineTextBoxBuilder.html Sets the starting character index for the inline text box. Accepts any type that can be converted into an i64. ```rust pub fn start_character_index( self, start_character_index: impl Into, ) -> InlineTextBoxBuilder ``` -------------------------------- ### Add Multiple Installability Errors Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/page/struct.GetInstallabilityErrorsReturnsBuilder.html Adds multiple installability errors to the builder. Accepts any type that can be converted into an iterator of items convertible to InstallabilityError. ```rust pub fn installability_errors( self, installability_errors: I, ) -> GetInstallabilityErrorsReturnsBuilder where I: IntoIterator, S: Into, ``` -------------------------------- ### InstallParams Struct Definition Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallParams.html Defines the structure for installation parameters, including the manifest ID and an optional URL for the app or bundle. ```rust pub struct InstallParams { pub manifest_id: String, pub install_url_or_bundle_url: Option, } ``` -------------------------------- ### Setting Worker Cache Lookup Start Time Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/network/struct.ResourceTimingBuilder.html Use the `worker_cache_lookup_start` method to set the time when the worker cache lookup started. This method is part of the ResourceTimingBuilder. ```rust pub fn worker_cache_lookup_start( self, worker_cache_lookup_start: impl Into, ) -> ResourceTimingBuilder ``` -------------------------------- ### FrameManager::goto Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/handler/frame/struct.FrameManager.html Serves as the entry point for navigating a page or frame. ```APIDOC ## FrameManager::goto ### Description Serves as the entry point for navigating a page or frame. ### Signature ```rust pub fn goto(&mut self, req: FrameNavigationRequest) ``` ``` -------------------------------- ### AttributionReportingEventReportWindowsBuilder::start Method Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/storage/struct.AttributionReportingEventReportWindowsBuilder.html Sets the start time for the attribution reporting event report windows. Accepts any type that can be converted into an i64. ```rust pub fn start( self, start: impl Into, ) -> AttributionReportingEventReportWindowsBuilder ``` -------------------------------- ### CssStartingStyleBuilder Methods Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.CssStartingStyleBuilder.html Provides methods to configure CssStartingStyleBuilder. Use `range` to set the source range and `style_sheet_id` to specify the stylesheet. Finally, `build` constructs the CssStartingStyle object. ```rust pub fn range(self, range: impl Into) -> CssStartingStyleBuilder ``` ```rust pub fn style_sheet_id( self, style_sheet_id: impl Into, ) -> CssStartingStyleBuilder ``` ```rust pub fn build(self) -> CssStartingStyle ``` -------------------------------- ### ServiceWorkerVersionStatus Enum Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/service_worker/enum.ServiceWorkerVersionStatus.html The ServiceWorkerVersionStatus enum defines the possible states for a Service Worker version. These states include New, Installing, Installed, Activating, Activated, and Redundant. ```APIDOC ## Enum ServiceWorkerVersionStatus ### Description Represents the different states of a Service Worker version. ### Variants * **New**: The Service Worker is newly registered. * **Installing**: The Service Worker is currently being installed. * **Installed**: The Service Worker has been successfully installed. * **Activating**: The Service Worker is currently being activated. * **Activated**: The Service Worker has been successfully activated. * **Redundant**: The Service Worker is no longer needed and has been removed. ``` -------------------------------- ### Navigate to URL Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/page/struct.Page.html Use the goto method to navigate the page to a specified URL. This method resolves once the URL is fully loaded. ```rust pub async fn goto(&self, params: impl Into) -> Result<&Self> ``` -------------------------------- ### InstallReturns Struct Definition Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallReturns.html Defines the structure for PWA installation return values. It's an empty struct, indicating that the installation parameters are handled externally or through associated methods. ```rust pub struct InstallReturns {} ``` -------------------------------- ### Launch Browser and Interact with Page Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/index.html Launches a headless Chromium browser, navigates to a Wikipedia page, types a search query, and waits for navigation. Requires `futures` and `chromiumoxide` crates. Ensure Tokio is set up for async operations. ```rust use futures::StreamExt; use chromiumoxide::{Browser, BrowserConfig}; #[tokio::main] async fn main() -> Result<(), Box> { let (browser, mut handler) = Browser::launch(BrowserConfig::builder().with_head().build()?) .await?; let handle = tokio::spawn(async move { loop { let _event = handler.next().await.unwrap(); } }); let page = browser.new_page("https://en.wikipedia.org").await?; // type into the search field and hit `Enter`, // this triggers a navigation to the search result page page.find_element("input#searchInput") .await? .click() .await? .type_str("Rust programming language") .await? .press_key("Enter") .await?; let html = page.wait_for_navigation().await?.content().await?; handle.await?; Ok(()) } ``` -------------------------------- ### StartDesktopMirroringParams From Implementation Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.StartDesktopMirroringParams.html Provides a conversion from any type that can be converted into a String into a StartDesktopMirroringParams instance. ```rust fn from(url: T) -> StartDesktopMirroringParams where T: Into, ``` -------------------------------- ### Set wait for debugger on start Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/target/struct.SetAutoAttachParamsBuilder.html Configures whether to wait for the debugger to start on new browser targets. Use this when you need to pause execution immediately upon target creation. ```rust pub fn wait_for_debugger_on_start( self, wait_for_debugger_on_start: impl Into, ) -> SetAutoAttachParamsBuilder ``` -------------------------------- ### Command Implementation for InstallParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/pwa/struct.InstallParams.html Details the implementation of the `Command` trait for `InstallParams`, enabling it to be used as a command in the Chromium protocol. ```APIDOC ## Command for InstallParams Implements the `Command` trait, allowing `InstallParams` to be sent as a command. ### Associated Types #### `type Response = InstallReturns` Specifies the expected response type for this command. ### Methods #### `response_from_value(response: Value) -> Result` Deserializes the command response from a `Value`. #### `identifier(&self) -> Cow<'static, str>` Returns the unique identifier for this command (e.g., `PWA.install`). #### `domain_name(&self) -> Cow<'static, str>` Returns the domain name for this command (e.g., `PWA`). #### `method_name(&self) -> Cow<'static, str>` Returns the method name for this command (e.g., `install`). #### `split(&self) -> (Cow<'static, str>, Cow<'static, str>)` Splits the command identifier into domain and method names. ``` -------------------------------- ### SourceRangeBuilder Methods Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.SourceRangeBuilder.html These methods allow you to set the start line, start column, end line, and end column for a SourceRange. Each method returns the builder itself, enabling method chaining. ```rust pub fn start_line(self, start_line: impl Into) -> SourceRangeBuilder ``` ```rust pub fn start_column(self, start_column: impl Into) -> SourceRangeBuilder ``` ```rust pub fn end_line(self, end_line: impl Into) -> SourceRangeBuilder ``` ```rust pub fn end_column(self, end_column: impl Into) -> SourceRangeBuilder ``` -------------------------------- ### Getting Metadata with and_then Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/error/type.Result.html Demonstrates using `and_then` to chain fallible operations, such as getting file metadata and then its modification time. Handles potential errors like file not found. ```rust use std::{io::ErrorKind, path::Path}; // Note: on Windows "/" maps to "C:\\" let root_modified_time = Path::new("/").metadata().and_then(|md| md.modified()); assert!(root_modified_time.is_ok()); let should_fail = Path::new("/bad/path").metadata().and_then(|md| md.modified()); assert!(should_fail.is_err()); assert_eq!(should_fail.unwrap_err().kind(), ErrorKind::NotFound); ``` -------------------------------- ### StartTabMirroringParams Command Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.Command.html This command is used to start tab mirroring. It returns a StartTabMirroringReturns object. ```APIDOC ## impl Command for StartTabMirroringParams ### Description Starts tab mirroring. ### Response #### Success Response - **Response** (StartTabMirroringReturns) - The result of the command. ``` -------------------------------- ### GetStorageKeyParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/storage/struct.GetStorageKeyParams.html Represents the parameters for the Storage.getStorageKey command. It allows specifying a frame ID to get the storage key for a specific frame, or omitting it to get the storage key of the target executing the command. ```APIDOC ## Struct GetStorageKeyParams ### Description Returns storage key for the given frame. If no frame ID is provided, the storage key of the target executing this command is returned. ### Fields * `frame_id` (Option) - Optional - The ID of the frame for which to retrieve the storage key. ### Method `Storage.getStorageKey` ### Request Example ```json { "frame_id": "YOUR_FRAME_ID" } ``` ### Response (Response details not explicitly provided in the source, but typically would include storage key information) ### Error Handling (Error handling details not explicitly provided in the source) ``` -------------------------------- ### LoadSnapshotReturns::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/layer_tree/struct.LoadSnapshotReturns.html Constructs a new LoadSnapshotReturns instance. ```APIDOC ## LoadSnapshotReturns::new ### Signature ```rust pub fn new(snapshot_id: impl Into) -> LoadSnapshotReturns ``` ### Description Creates a new `LoadSnapshotReturns` with the given snapshot ID. ``` -------------------------------- ### container_query_highlight_configs method Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/overlay/struct.SetShowContainerQueryOverlaysParamsBuilder.html Sets multiple container query highlight configurations for the overlay. Use this when you have a collection of configurations to apply. ```rust pub fn container_query_highlight_configs( self, container_query_highlight_configs: I, ) -> SetShowContainerQueryOverlaysParamsBuilder where I: IntoIterator, S: Into, ``` -------------------------------- ### StartDesktopMirroringParams::builder Method Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/cast/struct.StartDesktopMirroringParams.html Provides a builder pattern for constructing StartDesktopMirroringParams instances. ```rust pub fn builder() -> StartDesktopMirroringParamsBuilder ``` -------------------------------- ### Build StartSamplingParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/memory/struct.StartSamplingParamsBuilder.html Finalizes the configuration and returns the StartSamplingParams object. Call this after setting all desired sampling parameters. ```rust pub fn build(self) -> StartSamplingParams ``` -------------------------------- ### LoadUnpackedReturns Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/extensions/struct.LoadUnpackedReturns.html Installs an unpacked extension from the filesystem similar to –load-extension CLI flags. Returns extension ID once the extension has been installed. Available if the client is connected using the –remote-debugging-pipe flag and the –enable-unsafe-extension-debugging flag is set. ```APIDOC ## Struct LoadUnpackedReturns Installs an unpacked extension from the filesystem similar to –load-extension CLI flags. Returns extension ID once the extension has been installed. Available if the client is connected using the –remote-debugging-pipe flag and the –enable-unsafe-extension-debugging flag is set. ### Fields * `id` (String): Extension id. ``` -------------------------------- ### SetSupportsTextReturns::new Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/css/struct.SetSupportsTextReturns.html Constructs a new SetSupportsTextReturns instance. ```APIDOC ### `new` ```rust pub fn new(supports: impl Into) -> SetSupportsTextReturns ``` Constructs a new `SetSupportsTextReturns`. ``` -------------------------------- ### StartTabMirroringParams Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/trait.MethodType.html Represents parameters for starting tab mirroring. ```APIDOC ## StartTabMirroringParams ### Description Starts mirroring the content of a specific tab. ### Method Not applicable (struct/params definition) ### Endpoint Not applicable (struct/params definition) ### Parameters This structure defines parameters for starting tab mirroring. Specific fields are not detailed in the source. ### Request Example ```json { "example": "tab mirroring parameters" } ``` ### Response Success response indicates tab mirroring has started. Specific fields are not detailed in the source. ``` -------------------------------- ### PartitioningBlobUrlIssueDetailsBuilder Methods Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/audits/struct.PartitioningBlobUrlIssueDetailsBuilder.html Methods available for building PartitioningBlobUrlIssueDetails. ```APIDOC ## PartitioningBlobUrlIssueDetailsBuilder ### Description A builder for creating `PartitioningBlobUrlIssueDetails`. ### Methods #### `url(self, url: impl Into) -> PartitioningBlobUrlIssueDetailsBuilder` Sets the URL for the issue. #### `partitioning_blob_url_info(self, partitioning_blob_url_info: impl Into) -> PartitioningBlobUrlIssueDetailsBuilder` Sets the partitioning blob URL information for the issue. #### `build(self) -> Result` Builds and returns the `PartitioningBlobUrlIssueDetails` object. Returns an error string if the build fails. ``` -------------------------------- ### Setting the Bucket Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/cdp/browser_protocol/storage/struct.StorageBucketInfoBuilder.html Configures the bucket for the StorageBucketInfoBuilder. ```rust pub fn bucket( self, bucket: impl Into, ) -> StorageBucketInfoBuilder ``` -------------------------------- ### Get ElementQuad Width Source: https://docs.rs/chromiumoxide/latest/chromiumoxide/layout/struct.ElementQuad.html Returns the width of the ElementQuad. ```rust pub fn width(&self) -> f64 ```