Struct RealBrowserOptions 

pub struct RealBrowserOptions {

    pub engine: EngineType,
    pub channel: String,
    pub executable_path: Option<PathBuf>,
    pub user_data_dir: Option<PathBuf>,
    pub profile_directory: String,
    pub default_browser_check: Option<bool>,
    pub first_run: bool,
    pub preferences: Value,
    pub local_state: Value,
    pub storage_state: Option<StorageStateInput>,
    pub remote_debugging_port: Option<u16>,
    pub port_attempts: u32,
    pub headless: bool,
    pub restrictions: Vec<String>,
    pub args: Vec<String>,
    pub extra_args: Vec<String>,
    pub ignore_default_args: Vec<String>,
    pub ignore_all_default_args: bool,
    pub env: Option<HashMap<String, String>>,
    pub automation_parity: bool,
    pub startup_timeout: Duration,
    pub close_timeout: Duration,
    pub slow_mo: u64,
    pub timeout: Option<Duration>,
    pub protocol_timeout: Option<Duration>,
    pub seed_cookies: Vec<Value>,
    pub migrate_from: Option<MigrationSource>,
    pub migrate_include: Option<Vec<String>>,
    pub migrate_domains: Vec<String>,
    pub migrate_password_csv: Option<PathBuf>,
    pub migrate_include_payment_cards: bool,
    pub verbose: bool,
    pub node_executable: Option<PathBuf>,
    pub node_working_dir: Option<PathBuf>,
    pub downloads: DownloadSetting,
}

Options for launching an installed browser and attaching over CDP.

Fields

engine: EngineType

Browser Commander engine used after the browser starts.

channel: String

Installed Chrome-family channel to discover.

executable_path: Option<PathBuf>

Explicit installed-browser executable, bypassing channel discovery.

user_data_dir: Option<PathBuf>

Dedicated, non-default browser profile. When None a fresh temporary profile is created for the launch and deleted when the browser exits.

profile_directory: String

Profile whose Preferences are seeded before launch.

default_browser_check: Option<bool>

Whether to ask to become the OS default browser. Defaults to false.

first_run: bool

Allow the browser’s first-run flow in a fresh profile.

preferences: Value

JSON object deep-merged into Default/Preferences before launch.

local_state: Value

JSON object deep-merged into Local State before launch.

storage_state: Option<StorageStateInput>

Playwright-compatible cookie and localStorage state to restore.

remote_debugging_port: Option<u16>

Fixed loopback CDP port. When None a free port is reserved (and a lost port race retried). Zero is refused: it makes Chrome enable AutomationControlled.

port_attempts: u32

Ports to try when the port is reserved by the launcher.

headless: bool

Run the installed browser headlessly (--headless=new).

restrictions: Vec<String>

Opt-in restrictions from the shared catalogue, such as no-extensions or the legacy-defaults preset. See restrictions.

args: Vec<String>

Additional browser arguments.

extra_args: Vec<String>

Additional browser arguments appended after the compatibility args.

ignore_default_args: Vec<String>

Ignored since issue #103: there are no Browser Commander defaults left to omit. Kept so existing code compiles.

ignore_all_default_args: bool

Ignored since issue #103; see ignore_default_args.

env: Option<HashMap<String, String>>

Extra environment for the browser process only. The caller’s process environment is never modified.

automation_parity: bool

Add --disable-blink-features=AutomationControlled when the command line contains a switch that would turn navigator.webdriver on (such as a caller-supplied --enable-automation). A plain launch, headful or headless, has none, so its command line stays exactly as typed.

startup_timeout: Duration

Maximum time to wait for Chrome’s DevTools endpoint.

close_timeout: Duration

Time allowed for browser exit before RealBrowserLaunchResult::close kills it.

slow_mo: u64

Delay Playwright/Puppeteer operations by this many milliseconds.

timeout: Option<Duration>

Optional connection timeout.

protocol_timeout: Option<Duration>

Optional Puppeteer timeout for individual CDP calls.

seed_cookies: Vec<Value>

Cookies to seed immediately after attaching.

migrate_from: Option<MigrationSource>

Read-only source profile to copy into the dedicated profile before launch.

migrate_include: Option<Vec<String>>

Data classes to copy. None selects every supported class.

migrate_domains: Vec<String>

Host/subdomain filters for migrated per-site data.

migrate_password_csv: Option<PathBuf>

Explicit Safari/Passwords CSV export to import before launching.

migrate_include_payment_cards: bool

Separate explicit consent to import payment cards before launching.

verbose: bool

Enable browser and connector logging; the browser’s output is mirrored.

node_executable: Option<PathBuf>

Node.js executable for Playwright/Puppeteer bridge engines.

node_working_dir: Option<PathBuf>

Directory where Node resolves Playwright/Puppeteer.

downloads: DownloadSetting

Manage the installed browser’s downloads.

The same setting and the same manager as LaunchOptions and ConnectOptions, which is what makes a download started by hand in a visible window land where an automated one does. See downloads.

Implementations

impl RealBrowserOptions

pub fn chromiumoxide() -> Self

Create native Chromiumoxide options.

pub fn playwright() -> Self

Create Playwright bridge options.

pub fn puppeteer() -> Self

Create Puppeteer bridge options.

pub fn channel(self, channel: impl Into<String>) -> Self

Select an installed browser channel.

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

Select an explicit installed-browser executable.

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

Select a dedicated browser profile instead of a temporary one.

pub fn storage_state(self, state: impl Into<StorageStateInput>) -> Self

Restore portable cookies and origin-scoped localStorage after connecting.

pub fn remote_debugging_port(self, port: u16) -> Self

Use a fixed loopback CDP port instead of a reserved one. Zero is refused at launch.

pub fn port_attempts(self, attempts: u32) -> Self

Set how many reserved ports to try when another process takes one.

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

Enable or disable headless mode.

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

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

Opt in to named launch restrictions or presets.

pub fn with_args(self, args: Vec<String>) -> Self

Set additional browser arguments.

pub fn with_extra_args(self, args: Vec<String>) -> Self

Add browser arguments after the compatibility args field.

pub fn ignore_default_args(self, args: Vec<String>) -> Self

👎Deprecated since 0.13.0:

Browser Commander adds no default switches any more; opt in with restrictions instead

Has no effect since issue #103: Browser Commander adds no defaults.

pub fn ignore_all_default_args(self) -> Self

👎Deprecated since 0.13.0:

Browser Commander adds no default switches any more; opt in with restrictions instead

Has no effect since issue #103: Browser Commander adds no defaults.

pub fn env(self, env: HashMap<String, String>) -> Self

Extra environment for the browser process only.

pub fn automation_parity(self, enabled: bool) -> Self

Keep navigator.webdriver false when a switch would turn it on.

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

Set the CDP readiness timeout.

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

Set how long closing waits for the browser to exit before killing it.

pub fn slow_mo(self, milliseconds: u64) -> Self

Set the engine operation delay.

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

Set the connection timeout.

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

Set Puppeteer’s timeout for individual CDP calls.

pub fn seed_cookies(self, cookies: Vec<Value>) -> Self

Seed cookies after attaching.

pub fn migrate_from(self, source: MigrationSource) -> Self

Copy supported profile data before launch and seed its cookies over CDP.

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

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

Restrict a profile migration to the selected data classes.

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

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

Restrict migrated cookies to the selected hosts.

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

Enable launch and connection logging.

pub fn node_executable(self, executable: impl Into<PathBuf>) -> Self

Override the Node.js executable for bridge engines.

pub fn node_working_dir(self, directory: impl Into<PathBuf>) -> Self

Set the directory where Node resolves Playwright/Puppeteer.

pub fn downloads(self, downloads: impl Into<DownloadSetting>) -> Self

Manage the installed browser’s downloads.

Arguments

• downloads - true for the defaults, false for none, or DownloadOptions

pub fn get_user_data_dir(&self) -> PathBuf

👎Deprecated since 0.13.0:

launch_real_browser uses a fresh temporary profile unless user_data_dir is set; read RealBrowserLaunchResult::user_data_dir

The profile a launch would use: the configured one, or Browser Commander’s old managed per-channel directory.

Trait Implementations

impl Clone for RealBrowserOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealBrowserOptions

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

Formats the value using the given formatter.

impl Default for RealBrowserOptions

fn default() -> Self

Returns the “default value” for a type.