Struct seed::browser::fetch::Request

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

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

impl<'a> Request<'a>

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

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

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

pub fn header(self, header: Header<'a>) -> Self

Set specific header.

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

Set HTTP method. Default method is GET.

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

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

Panics

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

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.

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.

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

Set request mode.

MDN reference

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

Set request credentials.

MDN reference

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

Set request cache mode.

MDN reference

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

Set request redirect mode.

MDN reference

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

Set request referrer.

MDN reference

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

Set request referrer policy.

MDN reference

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

Set request subresource integrity.

MDN reference

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

Set request timeout in milliseconds.

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();

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.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Request<'a>

Returns the "default value" for a type.

impl<'a, T: Into<Cow<'a, str>>> From<T> for Request<'a>

fn from(s: T) -> Request<'a>

Performs the conversion.

impl<'a> From<Url> for Request<'a>

fn from(url: Url) -> Request<'a>

Performs the conversion.

impl<'_> TryFrom<Request<'_>> for Request

type Error = FetchError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.