Trait RequestExt 

pub trait RequestExt<B>: Sized {
    // Required methods
    fn json<T: Serialize + ?Sized>(
        self,
        body: &T,
    ) -> Result<Request<Full<Bytes>>>;
    fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Request<B>>;
    fn multipart(
        self,
        form: Form,
    ) -> Result<Request<UnsyncBoxBody<Bytes, BodyError>>>;
    fn form<T: Serialize + ?Sized>(
        self,
        form: &T,
    ) -> Result<Request<Full<Bytes>>>;
    fn stream<S: Stream>(self, stream: S) -> Result<Request<StreamBody<S>>>;
    fn plain_text(self, body: impl Into<Bytes>) -> Result<Request<Full<Bytes>>>;
    fn empty(self) -> Result<Request<Empty<Bytes>>>;
    fn collect_into_bytes(
        self,
    ) -> impl Future<Output = Result<Request<Full<Bytes>>>> + Send
       where B: Body<Data = Bytes> + Send + 'static,
             B::Error: Error + Send + Sync;
    fn with_version(self, version: Version) -> Request<B>;
    fn with_method(self, method: Method) -> Request<B>;
    fn with_header<K>(self, key: K, value: HeaderValue) -> Request<B>
       where K: IntoHeaderName;
    fn with_headers(self, header_map: HeaderMap) -> Request<B>;
    fn send<S, R>(
        self,
        client: S,
    ) -> impl Future<Output = Result<S::Response>> + Send
       where B: Body<Data = Bytes> + Send + 'static,
             B::Error: Error + Send + Sync,
             S: Service<Request<ClientBody>, Response = Response<R>> + Send,
             R: Body,
             <S as Service<Request<ClientBody>>>::Error: Error + Send + Sync + 'static,
             <S as Service<Request<ClientBody>>>::Future: Send;

    // Provided methods
    fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Request<B>
       where U: Display,
             P: Display,
             Self: Sized { ... }
    fn bearer_auth<T>(self, token: T) -> Request<B>
       where T: Display { ... }
    fn send_timeout<S, R>(
        self,
        client: S,
        timeout: Duration,
    ) -> impl Future<Output = Result<Response<MaybeAbort<R>>>> + Send
       where B: Body<Data = Bytes> + Send + 'static,
             B::Error: Error + Send + Sync,
             S: Service<Request<ClientBody>, Response = Response<R>> + Send,
             <S as Service<Request<ClientBody>>>::Error: Error + Send + Sync + 'static,
             <S as Service<Request<ClientBody>>>::Future: Send,
             R: Body,
             Self: Sized { ... }
}

Extension trait for http::Request.

Required Methods

fn json<T: Serialize + ?Sized>(self, body: &T) -> Result<Request<Full<Bytes>>>

Available on crate feature json only.

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Request<B>>

Available on crate feature query only.

fn multipart( self, form: Form, ) -> Result<Request<UnsyncBoxBody<Bytes, BodyError>>>

Available on crate feature multipart only.

fn form<T: Serialize + ?Sized>(self, form: &T) -> Result<Request<Full<Bytes>>>

Available on crate feature form only.

fn stream<S: Stream>(self, stream: S) -> Result<Request<StreamBody<S>>>

fn plain_text(self, body: impl Into<Bytes>) -> Result<Request<Full<Bytes>>>

fn empty(self) -> Result<Request<Empty<Bytes>>>

fn collect_into_bytes( self, ) -> impl Future<Output = Result<Request<Full<Bytes>>>> + Send

where B: Body<Data = Bytes> + Send + 'static, B::Error: Error + Send + Sync,

fn with_version(self, version: Version) -> Request<B>

fn with_method(self, method: Method) -> Request<B>

fn with_header<K>(self, key: K, value: HeaderValue) -> Request<B>

where K: IntoHeaderName,

fn with_headers(self, header_map: HeaderMap) -> Request<B>

fn send<S, R>( self, client: S, ) -> impl Future<Output = Result<S::Response>> + Send

where B: Body<Data = Bytes> + Send + 'static, B::Error: Error + Send + Sync, S: Service<Request<ClientBody>, Response = Response<R>> + Send, R: Body, <S as Service<Request<ClientBody>>>::Error: Error + Send + Sync + 'static, <S as Service<Request<ClientBody>>>::Future: Send,

Provided Methods

fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Request<B>

where U: Display, P: Display, Self: Sized,

Available on crate feature auth only.

fn bearer_auth<T>(self, token: T) -> Request<B>

where T: Display,

Available on crate feature auth only.

fn send_timeout<S, R>( self, client: S, timeout: Duration, ) -> impl Future<Output = Result<Response<MaybeAbort<R>>>> + Send

where B: Body<Data = Bytes> + Send + 'static, B::Error: Error + Send + Sync, S: Service<Request<ClientBody>, Response = Response<R>> + Send, <S as Service<Request<ClientBody>>>::Error: Error + Send + Sync + 'static, <S as Service<Request<ClientBody>>>::Future: Send, R: Body, Self: Sized,

Available on crate feature rt-tokio only.

Send the request to a service with a timeout layer.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<B> RequestExt<B> for Request<B>

where B: Send,

fn json<T: Serialize + ?Sized>(self, body: &T) -> Result<Request<Full<Bytes>>>

Available on crate feature json only.

Set the request body as JSON.

fn query<Q: Serialize + ?Sized>(self, query: &Q) -> Result<Request<B>>

Available on crate feature query only.

Add query parameters to the request URI.

fn multipart(self, form: Form) -> Result<Request<DynBody>>

Available on crate feature multipart only.

Set the request body as multipart form data.

fn form<T: Serialize + ?Sized>(self, form: &T) -> Result<Request<Full<Bytes>>>

Available on crate feature form only.

Set the request body as form data.

fn plain_text(self, body: impl Into<Bytes>) -> Result<Request<Full<Bytes>>>

Set the request body as plain text.

fn stream<S: Stream>(self, stream: S) -> Result<Request<StreamBody<S>>>

Set the request body as a stream.

fn empty(self) -> Result<Request<Empty<Bytes>>>

Set the request body as empty.

async fn collect_into_bytes(self) -> Result<Request<Full<Bytes>>>

where B: Body<Data = Bytes> + Send + 'static, B::Error: Error + Send + Sync,

Collect the request body stream into bytes. This is useful when you want to clone the request.

fn with_version(self, version: Version) -> Request<B>

Set the request HTTP version.

fn with_method(self, method: Method) -> Request<B>

Set the request method.

fn with_header<K>(self, key: K, value: HeaderValue) -> Request<B>

where K: IntoHeaderName,

Set a request header.

fn with_headers(self, header_map: HeaderMap) -> Request<B>

Extend multiple request headers.

async fn send<S, R>(self, client: S) -> Result<S::Response>

where B: Body<Data = Bytes> + Send + 'static, B::Error: Error + Send + Sync, S: Service<Request<ClientBody>, Response = Response<R>> + Send, R: Body, <S as Service<Request<ClientBody>>>::Error: Error + Send + Sync + 'static, <S as Service<Request<ClientBody>>>::Future: Send,

Send the request to a service.

If you enabled any decompression feature, the response body will be automatically decompressed.

Implementors