Struct APIRequestOptions 

#[non_exhaustive]
pub struct APIRequestOptions {
    pub headers: Option<HashMap<String, String>>,
    pub params: Option<Vec<(String, String)>>,
    pub data: Option<Value>,
    pub form: Option<HashMap<String, String>>,
    pub timeout: Option<f64>,
}

Options for crate::APIRequestContext requests.

Mirrors the relevant subset of Playwright’s API request options. data (JSON body) and form (URL-encoded form) are mutually exclusive; if both are set, data wins.

See: https://playwright.dev/docs/api/class-apirequestcontext#api-request-context-get

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.

headers: Option<HashMap<String, String>>

Per-request headers (merged on top of the context’s default headers).

params: Option<Vec<(String, String)>>

URL query parameters.

data: Option<Value>

JSON request body. Sent as application/json.

form: Option<HashMap<String, String>>

URL-encoded form body. Sent as application/x-www-form-urlencoded.

timeout: Option<f64>

Per-request timeout, in milliseconds.

Implementations

impl APIRequestOptions

pub fn new() -> Self

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

Set the per-request headers (replaces any previously set headers).

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

Add a single header.

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

Set the JSON body.

pub fn form(self, v: HashMap<String, String>) -> Self

Set the URL-encoded form body.

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

Set the URL query parameters.

pub fn timeout_ms(self, v: f64) -> Self

Set the per-request timeout in milliseconds.

Trait Implementations

impl Clone for APIRequestOptions

fn clone(&self) -> APIRequestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIRequestOptions

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

Formats the value using the given formatter.

impl Default for APIRequestOptions

fn default() -> APIRequestOptions

Returns the “default value” for a type.