Struct ScreenshotConfig

pub struct ScreenshotConfig {

    pub url: String,
    pub format: Option<ScreenshotFormat>,
    pub capture: Option<String>,
    pub resolution: Option<String>,
    pub country: Option<String>,
    pub timeout: Option<u32>,
    pub rendering_wait: Option<u32>,
    pub wait_for_selector: Option<String>,
    pub options: Vec<ScreenshotOption>,
    pub auto_scroll: bool,
    pub js: Option<String>,
    pub cache: bool,
    pub cache_ttl: Option<u32>,
    pub cache_clear: bool,
    pub webhook: Option<String>,
    pub vision_deficiency: Option<VisionDeficiencyType>,
}

Configuration for a POST /screenshot request.

Fields

url: String

Target URL (required).

format: Option<ScreenshotFormat>

Image format.

capture: Option<String>

fullpage or a CSS selector.

resolution: Option<String>

Viewport resolution (e.g. 1920x1080).

country: Option<String>

Proxy country.

timeout: Option<u32>

Timeout in milliseconds.

rendering_wait: Option<u32>

Extra rendering wait (ms).

wait_for_selector: Option<String>

Wait for CSS selector.

options: Vec<ScreenshotOption>

Capture options.

auto_scroll: bool

Enable auto-scroll.

js: Option<String>

Custom JavaScript (base64url-encoded on the wire).

cache: bool

Enable cache.

cache_ttl: Option<u32>

Cache TTL (seconds).

cache_clear: bool

Force cache refresh.

webhook: Option<String>

Webhook name.

vision_deficiency: Option<VisionDeficiencyType>

Simulated vision deficiency.

Implementations

impl ScreenshotConfig

pub fn builder(url: impl Into<String>) -> ScreenshotConfigBuilder

Start a builder for url.

pub fn to_query_pairs(&self) -> Result<Vec<(String, String)>, ScrapflyError>

Serialize into query-param pairs. Mirrors toAPIParams in the Go SDK.

Trait Implementations

impl Clone for ScreenshotConfig

fn clone(&self) -> ScreenshotConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScreenshotConfig

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

Formats the value using the given formatter.

impl Default for ScreenshotConfig

fn default() -> ScreenshotConfig

Returns the “default value” for a type.