Skip to main content

BrowserOptions

Struct BrowserOptions 

Source
pub struct BrowserOptions(/* private fields */);
Expand description

Options for a SpiderBrowser created via Spider::browser.

The API key is injected from the Spider client, so it does not need to be set here. Use the chainable with_* methods to configure the browser:

use spider_client::{BrowserOptions, Spider};

let spider = Spider::new(Some("myspiderapikey".into())).expect("API key must be provided");
let options = BrowserOptions::new()
    .with_browser("chrome")
    .with_stealth(2)
    .with_country("US");
let browser = spider.browser(Some(options));

Implementations§

Source§

impl BrowserOptions

Source

pub fn new() -> Self

Create a new set of browser options with defaults.

Source

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

Set the browser type (e.g. “chrome”, “firefox”, “auto”).

Source

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

Override the default WebSocket server URL.

Source

pub fn with_stealth(self, level: u32) -> Self

Set the initial stealth level (1-3, 0 = auto-escalate).

Source

pub fn with_llm(self, config: LLMConfig) -> Self

Set the LLM configuration for AI-powered actions.

Source

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

Set the captcha handling mode (“off”, “detect”, “solve”).

Source

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

Set the country code for geo-located proxies (e.g. “US”, “GB”).

Source

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

Set a custom proxy URL (e.g. “http://user:pass@proxy:8080”).

Source

pub fn with_record(self, record: bool) -> Self

Enable or disable screencast recording.

Source

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

Set the browser mode (“scraping” or “cua”).

Trait Implementations§

Source§

impl Clone for BrowserOptions

Source§

fn clone(&self) -> BrowserOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BrowserOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BrowserOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more