Struct APIRequestContext 

pub struct APIRequestContext { /* private fields */ }

APIRequestContext provides methods for making HTTP requests.

This is the Playwright protocol object that performs actual HTTP operations. It is created automatically for each BrowserContext and can be accessed via BrowserContext::request().

Used internally by Route::fetch() to perform the actual network request.

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

Implementations

impl APIRequestContext

pub fn new( parent: ParentOrConnection, type_name: String, guid: Arc<str>, initializer: Value, ) -> Result<Self>

pub async fn get( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a GET request.

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

pub async fn post( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a POST request.

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

pub async fn put( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a PUT request.

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

pub async fn delete( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a DELETE request.

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

pub async fn patch( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a PATCH request.

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

pub async fn head( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a HEAD request.

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

pub async fn fetch( &self, url: &str, options: impl Into<Option<FetchOptions>>, ) -> Result<APIResponse>

Sends a fetch request with the given options, returning an APIResponse.

This is the public-facing fetch method that returns a lazy APIResponse. The response body is not fetched until body(), text(), or json() is called.

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

pub async fn add_cookies(&self, cookies: &[Cookie]) -> Result<()>

Adds cookies to this request context’s cookie jar. For the context a BrowserContext or Page exposes through request(), that is the browser context’s jar, so the cookies reach its pages too.

Each cookie needs a url, or a domain and path.

Errors

Returns error if a cookie has neither a url nor a domain and path, or the context has been disposed.

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

pub async fn cookies(&self, urls: Option<&[&str]>) -> Result<Vec<Cookie>>

Returns the cookies in this request context’s jar, filtered to those that apply to urls when given.

Errors

Returns error if the context has been disposed.

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

pub async fn clear_cookies( &self, options: impl Into<Option<ClearCookiesOptions>>, ) -> Result<()>

Removes cookies from this request context’s jar: all of them, or those matching every filter set in options.

Errors

Returns error if the context has been disposed.

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

pub async fn dispose(&self) -> Result<()>

Disposes this APIRequestContext, freeing server resources.

After calling dispose(), the context cannot be used for further requests.

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

Trait Implementations

impl Clone for APIRequestContext

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for APIRequestContext

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

Formats the value using the given formatter.