Skip to main content

BrowserRequest

Struct BrowserRequest 

Source
pub struct BrowserRequest(/* private fields */);
Expand description

A fetch request made in the browser.

Methods from Deref<Target = Request>§

Source

pub fn url(&self) -> String

The URL of the request.

Source

pub fn headers(&self) -> Headers

Gets the headers.

Source

pub fn body_used(&self) -> bool

Has the request body been consumed?

If true, then any future attempts to consume the body will error.

Source

pub fn body(&self) -> Option<ReadableStream>

Gets the body.

Source

pub async fn form_data(&self) -> Result<FormData, Error>

Reads the request to completion, returning it as FormData.

Source

pub async fn json<T>(&self) -> Result<T, Error>

Reads the request to completion, parsing it as JSON.

Source

pub async fn text(&self) -> Result<String, Error>

Reads the reqeust as a String.

Source

pub async fn binary(&self) -> Result<Vec<u8>, Error>

Gets the binary request

This works by obtaining the response as an ArrayBuffer, creating a Uint8Array from it and then converting it to Vec<u8>

Source

pub fn mode(&self) -> RequestMode

Return the read only mode for the request

Source

pub fn method(&self) -> Method

Return the parsed method for the request

Trait Implementations§

Source§

impl<E> ClientReq<E> for BrowserRequest

Source§

type FormData = BrowserFormData

The type used for URL-encoded form data in this client.
Source§

fn try_new_req_query( path: &str, content_type: &str, accepts: &str, query: &str, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with query parameters.
Source§

fn try_new_req_text( path: &str, content_type: &str, accepts: &str, body: String, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with a text body.
Source§

fn try_new_req_bytes( path: &str, content_type: &str, accepts: &str, body: Bytes, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with a binary body.
Source§

fn try_new_req_multipart( path: &str, accepts: &str, body: <BrowserRequest as ClientReq<E>>::FormData, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with a multipart body.
Source§

fn try_new_req_form_data( path: &str, accepts: &str, content_type: &str, body: <BrowserRequest as ClientReq<E>>::FormData, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with form data as the body.
Source§

fn try_new_req_streaming( path: &str, accepts: &str, content_type: &str, body: impl Stream<Item = Bytes> + 'static, method: Method, ) -> Result<BrowserRequest, E>

Attempts to construct a new request with a streaming body.
Source§

fn try_new_get( path: &str, content_type: &str, accepts: &str, query: &str, ) -> Result<Self, E>

Attempts to construct a new GET request.
Source§

fn try_new_delete( path: &str, content_type: &str, accepts: &str, query: &str, ) -> Result<Self, E>

Attempts to construct a new DELETE request. Note: Browser support for DELETE requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_post( path: &str, content_type: &str, accepts: &str, body: String, ) -> Result<Self, E>

Attempts to construct a new POST request with a text body.
Source§

fn try_new_patch( path: &str, content_type: &str, accepts: &str, body: String, ) -> Result<Self, E>

Attempts to construct a new PATCH request with a text body. Note: Browser support for PATCH requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_put( path: &str, content_type: &str, accepts: &str, body: String, ) -> Result<Self, E>

Attempts to construct a new PUT request with a text body. Note: Browser support for PUT requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_post_bytes( path: &str, content_type: &str, accepts: &str, body: Bytes, ) -> Result<Self, E>

Attempts to construct a new POST request with a binary body.
Source§

fn try_new_patch_bytes( path: &str, content_type: &str, accepts: &str, body: Bytes, ) -> Result<Self, E>

Attempts to construct a new PATCH request with a binary body. Note: Browser support for PATCH requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_put_bytes( path: &str, content_type: &str, accepts: &str, body: Bytes, ) -> Result<Self, E>

Attempts to construct a new PUT request with a binary body. Note: Browser support for PUT requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_post_form_data( path: &str, accepts: &str, content_type: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new POST request with form data as the body.
Source§

fn try_new_patch_form_data( path: &str, accepts: &str, content_type: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new PATCH request with form data as the body. Note: Browser support for PATCH requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_put_form_data( path: &str, accepts: &str, content_type: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new PUT request with form data as the body. Note: Browser support for PUT requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_post_multipart( path: &str, accepts: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new POST request with a multipart body.
Source§

fn try_new_patch_multipart( path: &str, accepts: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new PATCH request with a multipart body. Note: Browser support for PATCH requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_put_multipart( path: &str, accepts: &str, body: Self::FormData, ) -> Result<Self, E>

Attempts to construct a new PUT request with a multipart body. Note: Browser support for PUT requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_post_streaming( path: &str, accepts: &str, content_type: &str, body: impl Stream<Item = Bytes> + Send + 'static, ) -> Result<Self, E>

Attempts to construct a new POST request with a streaming body.
Source§

fn try_new_patch_streaming( path: &str, accepts: &str, content_type: &str, body: impl Stream<Item = Bytes> + Send + 'static, ) -> Result<Self, E>

Attempts to construct a new PATCH request with a streaming body. Note: Browser support for PATCH requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

fn try_new_put_streaming( path: &str, accepts: &str, content_type: &str, body: impl Stream<Item = Bytes> + Send + 'static, ) -> Result<Self, E>

Attempts to construct a new PUT request with a streaming body. Note: Browser support for PUT requests without JS/WASM may be poor. Consider using a POST request if functionality without JS/WASM is required.
Source§

impl Debug for BrowserRequest

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for BrowserRequest

Source§

type Target = Request

The resulting type after dereferencing.
Source§

fn deref(&self) -> &<BrowserRequest as Deref>::Target

Dereferences the value.
Source§

impl DerefMut for BrowserRequest

Source§

fn deref_mut(&mut self) -> &mut <BrowserRequest as Deref>::Target

Mutably dereferences the value.
Source§

impl From<BrowserRequest> for Request

Source§

fn from(value: BrowserRequest) -> Request

Converts to this type from the input type.
Source§

impl From<BrowserRequest> for Request

Source§

fn from(value: BrowserRequest) -> Request

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.