Struct headless_chrome::LaunchOptionsBuilder

source ·

pub struct LaunchOptionsBuilder<'a> { /* private fields */ }

Expand description

Builder for LaunchOptions.

Implementations§

source §

impl<'a> LaunchOptionsBuilder<'a>

source

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

Determines whether to run headless version of the browser. Defaults to true.

source

pub fn sandbox(&mut self, value: bool) -> &mut Self

Determines whether to run the browser with a sandbox.

source

pub fn window_size(&mut self, value: Option<(u32, u32)>) -> &mut Self

Launch the browser with a specific window width and height.

source

pub fn port(&mut self, value: Option<u16>) -> &mut Self

Launch the browser with a specific debugging port.

source

pub fn ignore_certificate_errors(&mut self, value: bool) -> &mut Self

Determines whether SSL certificates should be verified. This is unsafe and can lead to MiTM attacks. Make sure you understand the risks See https://www.owasp.org/index.php/Man-in-the-middle_attack

source

pub fn path(&mut self, value: Option<PathBuf>) -> &mut Self

Path for Chrome or Chromium.

If unspecified, the create will try to automatically detect a suitable binary.

Examples found in repository ?

src/browser/mod.rs (line 108)

    pub fn default() -> Result<Self> {
        let launch_options = LaunchOptions::default_builder()
            .path(Some(default_executable().unwrap()))
            .build()
            .unwrap();
        Ok(Self::new(launch_options).unwrap())
    }

source

pub fn user_data_dir(&mut self, value: Option<PathBuf>) -> &mut Self

User Data (Profile) to use.

If unspecified, a new temp directory is created and used on every launch.

source

pub fn extensions(&mut self, value: Vec<&'a OsStr>) -> &mut Self

A list of Chrome extensions to load.

An extension should be a path to a folder containing the extension code. CRX files cannot be used directly and must be first extracted.

Note that Chrome does not support loading extensions in headless-mode. See https://bugs.chromium.org/p/chromium/issues/detail?id=706008#c5

source

pub fn args(&mut self, value: Vec<&'a OsStr>) -> &mut Self

Additional arguments to pass to the browser instance. The list of Chromium flags can be found: http://peter.sh/experiments/chromium-command-line-switches/.

source

pub fn disable_default_args(&mut self, value: bool) -> &mut Self

Disable default arguments

source

pub fn idle_browser_timeout(&mut self, value: Duration) -> &mut Self

How long to keep the WebSocket to the browser for after not receiving any events from it Defaults to 30 seconds

source

pub fn process_envs(
&mut self,
value: Option<HashMap<String, String>>
) -> &mut Self

Environment variables to set for the Chromium process. Passes value through to std::process::Command::envs.

source

pub fn proxy_server(&mut self, value: Option<&'a str>) -> &mut Self

Setup the proxy server for headless chrome instance

source

pub fn build(&self) -> Result<LaunchOptions<'a>, LaunchOptionsBuilderError>

Builds a new LaunchOptions.

Errors

If a required field has not been initialized.

Examples found in repository ?

src/browser/mod.rs (line 109)

    pub fn default() -> Result<Self> {
        let launch_options = LaunchOptions::default_builder()
            .path(Some(default_executable().unwrap()))
            .build()
            .unwrap();
        Ok(Self::new(launch_options).unwrap())
    }