Struct ApiRequestContextOptions 

#[non_exhaustive]
pub struct ApiRequestContextOptions {
    pub base_url: Option<String>,
    pub user_agent: Option<String>,
    pub timeout: Option<Duration>,
    pub ignore_https_errors: bool,
    pub extra_http_headers: Headers,
}

Configuration for building an APIRequestContext.

Mirrors the relevant subset of Playwright’s newContext({ baseURL, ... }) options that apply to a standalone API request context. Use Default for sensible no-op defaults, then chain the builder setters:

let opts = ApiRequestContextOptions::default()
    .base_url("https://api.example.com")
    .user_agent("my-bot/1.0")
    .timeout(Duration::from_secs(30))
    .ignore_https_errors(true);

See: https://playwright.dev/docs/api/class-apirequestcontext

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

base_url: Option<String>

Base URL prepended to any relative request URL (one that does not start with http:// or https://).

user_agent: Option<String>

User-Agent header applied to every request. Per-request headers take precedence.

timeout: Option<Duration>

Default per-request timeout. Overridden by a per-request timeout in APIRequestOptions.

ignore_https_errors: bool

When true, the underlying reqwest::Client accepts invalid TLS certificates (mirrors Playwright’s ignoreHTTPSErrors).

extra_http_headers: Headers

Extra headers merged into every request, below per-request headers.

Implementations

impl ApiRequestContextOptions

pub fn new() -> Self

Start from defaults.

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

Set the base URL prepended to relative request URLs.

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

Set the User-Agent header applied to every request.

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

Set the default per-request timeout.

pub fn ignore_https_errors(self, ignore: bool) -> Self

When true, accept invalid TLS certificates.

pub fn extra_http_headers(self, headers: Headers) -> Self

Set the extra headers merged into every request (replaces any previously set extras).

pub fn extra_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Add a single extra header.

Trait Implementations

impl Clone for ApiRequestContextOptions

fn clone(&self) -> ApiRequestContextOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiRequestContextOptions

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

Formats the value using the given formatter.

impl Default for ApiRequestContextOptions

fn default() -> ApiRequestContextOptions

Returns the “default value” for a type.