Struct Browser

Source

pub struct Browser { /* private fields */ }

Expand description

Browser represents a browser instance.

A Browser is created when you call BrowserType::launch(). It provides methods to create browser contexts and pages.

§Example

use playwright_rs::protocol::Playwright;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let playwright = Playwright::launch().await?;
    let chromium = playwright.chromium();

    let browser = chromium.launch().await?;
    println!("Browser: {} version {}", browser.name(), browser.version());
    assert!(browser.is_connected());

    let bt = browser.browser_type();
    assert_eq!(bt.name(), "chromium");

    let context = browser.new_context().await?;
    let _page = context.new_page().await?;
    assert_eq!(browser.contexts().len(), 1);

    browser.on_disconnected(|| async { Ok(()) }).await?;

    browser.start_tracing(None).await?;
    let _trace_bytes = browser.stop_tracing().await?;

    browser.close().await?;
    Ok(())
}

See: https://playwright.dev/docs/api/class-browser

Implementations§

Source §

impl Browser

Source

pub fn new( parent: Arc<dyn ChannelOwner>, type_name: String, guid: Arc<str>, initializer: Value, ) -> Result<Self>

Creates a new Browser from protocol initialization

This is called by the object factory when the server sends a __create__ message for a Browser object.

§Arguments

parent - The parent BrowserType object
type_name - The protocol type name (“Browser”)
guid - The unique identifier for this browser instance
initializer - The initialization data from the server

§Errors

Returns error if initializer is missing required fields (version, name)

Source

pub fn version(&self) -> &str

Returns the browser version string.

See: https://playwright.dev/docs/api/class-browser#browser-version

Source

pub fn name(&self) -> &str

Returns the browser name (e.g., “chromium”, “firefox”, “webkit”).

See: https://playwright.dev/docs/api/class-browser#browser-name

Source

pub fn is_connected(&self) -> bool

Returns true if the browser is connected.

The browser is connected when it is launched and becomes disconnected when:

browser.close() is called
The browser process crashes
The browser is closed by the user

See: https://playwright.dev/docs/api/class-browser#browser-is-connected

Source

pub async fn new_context(&self) -> Result<BrowserContext>

Creates a new browser context.

A browser context is an isolated session within the browser instance, similar to an incognito profile. Each context has its own cookies, cache, and local storage.

§Errors

Returns error if:

Browser has been closed
Communication with browser process fails

See: https://playwright.dev/docs/api/class-browser#browser-new-context

Source

pub async fn new_context_with_options( &self, options: BrowserContextOptions, ) -> Result<BrowserContext>

Creates a new browser context with custom options.

A browser context is an isolated session within the browser instance, similar to an incognito profile. Each context has its own cookies, cache, and local storage.

This method allows customizing viewport, user agent, locale, timezone, and other settings.

§Errors

Returns error if:

Browser has been closed
Communication with browser process fails
Invalid options provided
Storage state file cannot be read or parsed

See: https://playwright.dev/docs/api/class-browser#browser-new-context

Source

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

Creates a new page in a new browser context.

This is a convenience method that creates a default context and then creates a page in it. This is equivalent to calling browser.new_context().await?.new_page().await?.

The created context is not directly accessible, but will be cleaned up when the page is closed.