Struct ScrapeConfigBuilder

pub struct ScrapeConfigBuilder { /* private fields */ }

Builder for ScrapeConfig.

Implementations

impl ScrapeConfigBuilder

pub fn method(self, m: HttpMethod) -> Self

Set HTTP method.

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

Set raw request body.

pub fn header(self, k: impl Into<String>, v: impl Into<String>) -> Self

Set a custom header.

pub fn headers(self, headers: BTreeMap<String, String>) -> Self

Replace the full header map.

pub fn cookie(self, k: impl Into<String>, v: impl Into<String>) -> Self

Set a cookie.

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

Set proxy country.

pub fn proxy_pool(self, p: ProxyPool) -> Self

Set proxy pool.

pub fn render_js(self, v: bool) -> Self

Enable JS rendering.

pub fn asp(self, v: bool) -> Self

Enable ASP bypass.

pub fn cache(self, v: bool) -> Self

Enable cache.

pub fn cache_ttl(self, v: u32) -> Self

Set cache TTL.

pub fn cache_clear(self, v: bool) -> Self

Force cache refresh.

pub fn cost_budget(self, v: u32) -> Self

Set the maximum API credit cost the caller will accept for this request. The server rejects the request pre-flight if its estimate exceeds the budget, so callers get a fast failure instead of a surprise bill.

pub fn timeout(self, v: u32) -> Self

Set request timeout (ms).

pub fn retry(self, v: bool) -> Self

Set automatic retry flag.

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

Set session name.

pub fn session_sticky_proxy(self, v: bool) -> Self

Sticky proxy in a session.

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

Add a tag.

pub fn tags(self, v: Vec<String>) -> Self

Set all tags.

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

Set webhook name.

pub fn debug(self, v: bool) -> Self

Enable debug mode.

pub fn ssl(self, v: bool) -> Self

Capture SSL details.

pub fn dns(self, v: bool) -> Self

Capture DNS details.

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

Set correlation ID.

pub fn format(self, v: Format) -> Self

Set output format.

pub fn format_option(self, v: FormatOption) -> Self

Add a format option.

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

Set saved extraction template name.

pub fn extraction_ephemeral_template(self, v: Value) -> Self

Set inline extraction template.

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

Set AI extraction prompt.

pub fn extraction_model(self, v: ExtractionModel) -> Self

Set extraction model.

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

Set wait-for-selector.

pub fn rendering_wait(self, v: u32) -> Self

Set extra rendering wait (ms).

pub fn auto_scroll(self, v: bool) -> Self

Enable auto-scroll.

pub fn screenshot( self, name: impl Into<String>, selector: impl Into<String>, ) -> Self

Add a named screenshot.

pub fn screenshot_flag(self, v: ScreenshotFlag) -> Self

Add a screenshot flag.

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

Set inline JS code.

pub fn js_scenario(self, v: Value) -> Self

Set JS scenario (as serde_json::Value).

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

Set OS fingerprint hint.

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

Add an Accept-Language value.

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

Set browser brand.

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

Enable proxified response mode (raw upstream pass-through). Spoof browser geolocation. Format: "latitude,longitude".

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

Set page load stage: "complete" (default) or "domcontentloaded".

pub fn proxified_response(self) -> Self

pub fn build(self) -> Result<ScrapeConfig, ScrapflyError>

Finalize the builder, enforcing the mutual-exclusion rules for the extraction fields.

Trait Implementations

impl Clone for ScrapeConfigBuilder

fn clone(&self) -> ScrapeConfigBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScrapeConfigBuilder

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

Formats the value using the given formatter.