Struct seed::browser::fetch::Request

source · [−]

pub struct Request<'a> { /* private fields */ }

Expand description

Its methods configure the request, and handle the response. Many of them return the original struct, and are intended to be used chained together.

Implementations

source

impl<'a> Request<'a>

source

pub fn new(url: impl Into<Cow<'a, str>>) -> Self

Create new request based on the provided url.

To get a Response you need to pass Request to the fetch function.

MDN reference

source

pub fn headers(self, headers: Headers<'a>) -> Self

Set headers for this request. It will replace any existing headers.

Set specific header.

source

pub const fn method(self, method: Method) -> Self

Set HTTP method. Default method is GET.

source

pub fn body(self, body: JsValue) -> Self

Set request body to provided JsValue. Consider using json, text or bytes methods instead.

Panics

This method will panic when request method is GET or HEAD.

source

pub fn body_ref(self, body: &'a JsValue) -> Self

Set request body to provided JsValue by reference. Consider using json, text or bytes methods instead.

Panics

This method will panic when request method is GET or HEAD.

source

pub fn json<T: Serialize + ?Sized>(self, data: &T) -> Result<Self>

Set request body by JSON encoding provided data. It will also set Content-Type header to application/json; charset=utf-8.

Errors

This method can fail if JSON serialization fail. It will then return FetchError::SerdeError.

source

pub fn text(self, text: impl AsRef<str>) -> Self

Set request body to a provided string. It will also set Content-Type header to text/plain; charset=utf-8.

source

pub fn bytes(self, bytes: impl AsRef<[u8 ]>) -> Self

Set request body to the provided bytes. It will also set Content-Type header to application/octet-stream.

source

pub fn form_data(self, form_data: FormData) -> Self

Set request body to the provided form data object. It will also set Content-Type header to multipart/form-data.

source

pub const fn mode(self, mode: RequestMode) -> Self

Set request mode.

MDN reference

source

pub const fn credentials(self, credentials: RequestCredentials) -> Self

Set request credentials.

MDN reference

source

pub const fn cache(self, cache: RequestCache) -> Self

Set request cache mode.

MDN reference

source

pub const fn redirect(self, redirect: RequestRedirect) -> Self

Set request redirect mode.

MDN reference

source

pub fn referrer(self, referrer: &impl ToString) -> Self

Set request referrer.

MDN reference

source

pub const fn referrer_policy(self, referrer_policy: ReferrerPolicy) -> Self

Set request referrer policy.

MDN reference

source

pub fn integrity(self, integrity: &impl ToString) -> Self

Set request subresource integrity.

MDN reference

source

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

Set request timeout in milliseconds.

source

pub fn controller(self) -> (Self, RequestController )

Get the request controller that allows to abort request or disable request’s timeout.

Example

let (request, controller) = Request::new("http://example.com").controller();

source

pub async fn fetch(self) -> Result<Response>

Fetch request. It’s a chainable alternative to fetch(request).

Example

orders.perform_cmd({
    let message = model.new_message.clone();
    async { Msg::Fetched(send_message(message).await) }
});
...
async fn send_message(new_message: String) -> fetch::Result<shared::SendMessageResponseBody> {
    Request::new(get_request_url())
        .method(Method::Post)
        .json(&shared::SendMessageRequestBody { text: new_message })?
        .fetch()
        .await?
        .check_status()?
        .json()
        .await
}

Errors

fetch will return Err only on network errors. This means that even if you get Ok from this function, you still need to check Response status for HTTP errors.