Skip to main content

Request

server_fn::request::reqwest

Struct Request 

Source 
pub struct Request { /* private fields */ }
Expand description

A request which can be executed with Client::execute().

Implementations§

Source§

impl Request

Source

pub fn new(method: Method, url: Url) -> Request

Constructs a new request.

Source

pub fn method(&self) -> &Method

Get the method.

Source

pub fn method_mut(&mut self) -> &mut Method

Get a mutable reference to the method.

Source

pub fn url(&self) -> &Url

Get the url.

Source

pub fn url_mut(&mut self) -> &mut Url

Get a mutable reference to the url.

Source

pub fn headers(&self) -> &HeaderMap

Get the headers.

Source

pub fn headers_mut(&mut self) -> &mut HeaderMap

Get a mutable reference to the headers.

Source

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

Get the body.

Source

pub fn body_mut(&mut self) -> &mut Option<Body>

Get a mutable reference to the body.

Source

pub fn timeout(&self) -> Option<&Duration>

Get the timeout.

Source

pub fn timeout_mut(&mut self) -> &mut Option<Duration>

Get a mutable reference to the timeout.

Source

pub fn version(&self) -> Version

Get the http version.

Source

pub fn version_mut(&mut self) -> &mut Version

Get a mutable reference to the http version.

Source

pub fn try_clone(&self) -> Option<Request>

Attempt to clone the request.

None is returned if the request can not be cloned, i.e. if the body is a stream.

Trait Implementations§

Source§

impl<E> ClientReq<E> for Request
where E: FromServerFnError,

Source§

type FormData = Form

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<Self, 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<Self, 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<Self, E>

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

fn try_new_req_multipart( path: &str, accepts: &str, body: Self::FormData, method: Method, ) -> Result<Self, 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: Self::FormData, method: Method, ) -> Result<Self, 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> + Send + 'static, method: Method, ) -> Result<Self, 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 Request

Source§

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

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

impl Service<Request> for Client

Source§

type Response = Response

Responses given by the service.
Source§

type Error = Error

Errors produced by the service.
Source§

type Future = Pending

The future response value.
Source§

fn poll_ready( &mut self, _cx: &mut Context<'_>, ) -> Poll<Result<(), <Client as Service<Request>>::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, req: Request) -> <Client as Service<Request>>::Future

Process the request and return the response asynchronously. Read more
Source§

impl Service<Request> for &Client

Source§

type Response = Response

Responses given by the service.
Source§

type Error = Error

Errors produced by the service.
Source§

type Future = Pending

The future response value.
Source§

fn poll_ready( &mut self, _cx: &mut Context<'_>, ) -> Poll<Result<(), <&Client as Service<Request>>::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, req: Request) -> <&Client as Service<Request>>::Future

Process the request and return the response asynchronously. Read more
Source§

impl<T> TryFrom<Request<T>> for Request
where T: Into<Body>,

Source§

type Error = Error

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

fn try_from(req: Request<T>) -> Result<Request, Error>

Performs the conversion.

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<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<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more