Struct chromiumoxide::browser::Browser

pub struct Browser { /* fields omitted */ }

A Browser is created when chromiumoxide connects to a Chromium instance.

Implementations

impl Browser

pub async fn connect(debug_ws_url: impl Into<String>) -> Result<(Self, Handler)>

Connect to an already running chromium instance via websocket

pub async fn launch(config: BrowserConfig) -> Result<(Self, Handler)>

Launches a new instance of chromium in the background and attaches to its debug web socket.

This fails when no chromium executable could be detected.

This fails if no web socket url could be detected from the child processes stderr for more than 20 seconds.

pub async fn start_incognito_context(&mut self) -> Result<&mut Self>

If not launched as incognito this creates a new incognito browser context. After that this browser exists within the incognito session. New pages created while being in incognito mode will also run in the incognito context. Incognito contexts won’t share cookies/cache with other browser contexts.

pub async fn quit_incognito_context(&mut self) -> Result<&mut Self>

If a incognito session was created with Browser::start_incognito_context this disposes this context.

Note This will also dispose all pages that were running within the

incognito context.

pub fn websocket_address(&self) -> &String

Returns the address of the websocket this browser is attached to

pub fn is_incognito(&self) -> bool

Whether the BrowserContext is incognito.

pub fn config(&self) -> Option<&BrowserConfig>

The config of the spawned chromium instance if any.

pub async fn new_page(
    &self,
    params: impl Into<CreateTargetParams>
) -> Result<Page>

Create a new browser page

pub async fn version(&self) -> Result<GetVersionReturns>

Version information about the browser

pub async fn user_agent(&self) -> Result<String>

Returns the user agent of the browser

pub async fn execute<T: Command>(
    &self,
    cmd: T
) -> Result<CommandResponse<T::Response>>

Call a browser method.

pub async fn pages(&self) -> Result<Vec<Page>>

Return all of the pages of the browser

pub async fn get_page(&self, target_id: TargetId) -> Result<Page>

Return page of given target_id

Trait Implementations

impl Debug for Browser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for Browser

fn drop(&mut self)

Executes the destructor for this type.