Struct BrowserBuilder 

pub struct BrowserBuilder { /* private fields */ }

Builder for launching a browser.

Implementations

impl BrowserBuilder

pub fn new() -> Self

Create a new browser builder with default settings.

By default, the browser uses an isolated temporary directory for user data. This prevents conflicts when running multiple browser instances and ensures clean sessions for automation.

pub fn executable_path(self, path: impl Into<PathBuf>) -> Self

Set the path to the Chromium executable.

If not set, the launcher will search common paths and check the CHROMIUM_PATH environment variable.

pub fn headless(self, headless: bool) -> Self

Set whether to run in headless mode.

Default is true.

Examples found in repository

examples/basic_navigation.rs (line 24)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Launching browser...");

    // Launch a headless browser
    let browser = Browser::launch()
        .headless(true)
        .timeout(Duration::from_secs(30))
        .launch()
        .await?;

    println!("Browser launched successfully!");

    // Create a new browser context (isolated environment)
    let context = browser.new_context().await?;
    println!("Created browser context: {}", context.id());

    // Create a new page
    let page = context.new_page().await?;
    println!("Created page with target: {}", page.target_id());

    // Navigate to a URL with default wait (Load event)
    println!("\nNavigating to example.com...");
    let response = page.goto("https://example.com").goto().await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with DomContentLoaded wait (faster)
    println!("\nNavigating to httpbin.org with DomContentLoaded wait...");
    let response = page
        .goto("https://httpbin.org/html")
        .wait_until(DocumentLoadState::DomContentLoaded)
        .timeout(Duration::from_secs(15))
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with custom referer
    println!("\nNavigating with custom referer...");
    let response = page
        .goto("https://httpbin.org/headers")
        .referer("https://google.com")
        .wait_until(DocumentLoadState::Load)
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Close the browser
    println!("\nClosing browser...");
    browser.close().await?;
    println!("Done!");

    Ok(())
}

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add additional command line arguments.

pub fn timeout(self, timeout: Duration) -> Self

Set the launch timeout.

Default is 30 seconds.

Examples found in repository

examples/basic_navigation.rs (line 25)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Launching browser...");

    // Launch a headless browser
    let browser = Browser::launch()
        .headless(true)
        .timeout(Duration::from_secs(30))
        .launch()
        .await?;

    println!("Browser launched successfully!");

    // Create a new browser context (isolated environment)
    let context = browser.new_context().await?;
    println!("Created browser context: {}", context.id());

    // Create a new page
    let page = context.new_page().await?;
    println!("Created page with target: {}", page.target_id());

    // Navigate to a URL with default wait (Load event)
    println!("\nNavigating to example.com...");
    let response = page.goto("https://example.com").goto().await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with DomContentLoaded wait (faster)
    println!("\nNavigating to httpbin.org with DomContentLoaded wait...");
    let response = page
        .goto("https://httpbin.org/html")
        .wait_until(DocumentLoadState::DomContentLoaded)
        .timeout(Duration::from_secs(15))
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with custom referer
    println!("\nNavigating with custom referer...");
    let response = page
        .goto("https://httpbin.org/headers")
        .referer("https://google.com")
        .wait_until(DocumentLoadState::Load)
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Close the browser
    println!("\nClosing browser...");
    browser.close().await?;
    println!("Done!");

    Ok(())
}

pub fn user_data_dir(self, path: impl Into<PathBuf>) -> Self

Set a persistent user data directory for browser profile.

When set, browser state (cookies, localStorage, settings) persists in the specified directory across browser restarts. The directory is NOT cleaned up when the browser closes.

Note: Using the same directory for multiple concurrent browser instances will cause profile lock conflicts.

Example

use viewpoint_core::Browser;

let browser = Browser::launch()
    .user_data_dir("/path/to/profile")
    .launch()
    .await?;

pub fn user_data_dir_system(self) -> Self

Use the system default profile directory.

On Linux, this is typically ~/.config/chromium/. No --user-data-dir flag is passed to Chromium.

Warning: This can cause conflicts if another Chromium instance is running, or if a previous session crashed without proper cleanup. Prefer the default isolated temp profile for automation scenarios.

Example

use viewpoint_core::Browser;

let browser = Browser::launch()
    .user_data_dir_system()
    .launch()
    .await?;

pub fn user_data_dir_template_from( self, template_path: impl Into<PathBuf>, ) -> Self

Use a template profile copied to a temporary directory.

The contents of the template directory are copied to a new temporary directory. This allows starting with pre-configured settings, extensions, or cookies while maintaining isolation between sessions.

The temporary directory is automatically cleaned up when the browser closes or is dropped. The original template directory is unchanged.

Example

use viewpoint_core::Browser;

// Create a browser with extensions from a template profile
let browser = Browser::launch()
    .user_data_dir_template_from("/path/to/template-profile")
    .launch()
    .await?;

Loading Extensions

Extensions can also be loaded at runtime without a template profile:

use viewpoint_core::Browser;

let browser = Browser::launch()
    .args(["--load-extension=/path/to/unpacked-extension"])
    .launch()
    .await?;

pub async fn launch(self) -> Result<Browser, BrowserError>

Launch the browser.

Errors

Returns an error if:

• Chromium is not found
• The process fails to spawn
• The browser doesn’t start within the timeout
• Template directory doesn’t exist or can’t be copied

Examples found in repository

examples/basic_navigation.rs (line 26)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    println!("Launching browser...");

    // Launch a headless browser
    let browser = Browser::launch()
        .headless(true)
        .timeout(Duration::from_secs(30))
        .launch()
        .await?;

    println!("Browser launched successfully!");

    // Create a new browser context (isolated environment)
    let context = browser.new_context().await?;
    println!("Created browser context: {}", context.id());

    // Create a new page
    let page = context.new_page().await?;
    println!("Created page with target: {}", page.target_id());

    // Navigate to a URL with default wait (Load event)
    println!("\nNavigating to example.com...");
    let response = page.goto("https://example.com").goto().await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with DomContentLoaded wait (faster)
    println!("\nNavigating to httpbin.org with DomContentLoaded wait...");
    let response = page
        .goto("https://httpbin.org/html")
        .wait_until(DocumentLoadState::DomContentLoaded)
        .timeout(Duration::from_secs(15))
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Navigate with custom referer
    println!("\nNavigating with custom referer...");
    let response = page
        .goto("https://httpbin.org/headers")
        .referer("https://google.com")
        .wait_until(DocumentLoadState::Load)
        .goto()
        .await?;
    println!("Navigation complete! URL: {}", response.url());

    // Close the browser
    println!("\nClosing browser...");
    browser.close().await?;
    println!("Done!");

    Ok(())
}

Trait Implementations

impl Clone for BrowserBuilder

fn clone(&self) -> BrowserBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BrowserBuilder

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

Formats the value using the given formatter.

impl Default for BrowserBuilder

fn default() -> Self

Returns the “default value” for a type.