Struct seed::browser::service::fetch::Request

pub struct Request { /* fields omitted */ }

Request is the entry point for all fetch requests. Its methods configure the request, and handle the response. Many of them return the original struct, and are intended to be used chained together.

Methods

impl Request

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

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

Set the HTTP method. Default is GET.

MDN reference

pub fn header(self, name: &str, value: &str) -> Self

Add a single header. String multiple calls to this together to add multiple ones.

MDN reference

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

pub fn body_json<T: Serialize>(self, body_json: &T) -> Self

Serialize a Rust data structure as JSON; eg the payload in a POST request. Note: If you want to setup Content-Type header automatically, use method send_json.

pub fn send_json<T: Serialize>(self, data: &T) -> Self

Set body to serialized data and set header Content-Type to application/json; charset=utf-8.

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

MDN reference

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

MDN reference

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

MDN reference

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

MDN reference

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

MDN reference

pub fn referrer(self, referrer: String) -> Self

MDN reference

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

MDN reference

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

Enable request timeout and set it to given milliseconds.

pub fn controller(
    self,
    controller_transferrer: impl FnOnce(RequestController)
) -> Self

Get request controller through callback function. You can use controller to abort request or disable timeout.

Example

fn send_request(
   request_controller: &mut Option<fetch::RequestController>
) -> impl Future<Item=Msg, Error=Msg> {
   fetch::Request::new(get_request_url())
       .controller(|controller| *request_controller = Some(controller))
       .fetch_string(Msg::Fetched)
}

pub async fn fetch<U>(
    self,
    f: impl FnOnce(FetchObject<()>) -> U
) -> Result<U, U> where
    U: 'static, 

Fetch.

It never fails. Use callback f to map FetchObject<()>. E.g.: You can use std::convert::identity as f to return Result<FetchObject<()>, FetchObject<()>.

It's lazy - fetching is started when Future is executed.

It always set FetchObject.result->ResponseWithDataResult field data to Ok(()) - if you want to get body data, you have to use field raw to get raw web_sys::Response. (Or use methods like fetch_string / fetch_json.)

MDN reference

Example

async fn send_request() -> Result<Msg, Msg> {
   fetch::Request::new(get_request_url())
       .fetch(Msg::Fetched)
       .await
}

pub async fn fetch_string<U>(
    self,
    f: impl FnOnce(FetchObject<String>) -> U
) -> Result<U, U> where
    U: 'static, 

Same as method fetch, but try to convert body to String and insert it into Response field data. [MDN reference](https://developer.mozilla.org/en-US/docs/Web/API/Body/text]

pub fn fetch_string_data<U>(
    self,
    f: impl FnOnce(ResponseDataResult<String>) -> U
) -> impl Future<Output = Result<U, U>> where
    U: 'static, 

Fetch and then convert body to String. It passes ResponseDataResult<String> into callback f. MDN reference

pub async fn fetch_json<T, U>(
    self,
    f: impl FnOnce(FetchObject<T>) -> U
) -> Result<U, U> where
    T: DeserializeOwned + 'static,
    U: 'static, 

Same as method fetch, but try to deserialize body and insert it into Response field data.

pub fn fetch_json_data<T, U>(
    self,
    f: impl FnOnce(ResponseDataResult<T>) -> U
) -> impl Future<Output = Result<U, U>> where
    T: DeserializeOwned + 'static,
    U: 'static, 

Fetch and then deserialize body to T. It passes ResponseDataResult<T> into callback f.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Default for Request

fn default() -> Request

Returns the "default value" for a type.