Skip to main content

RequestBuilder

rama_http::service::client

Struct RequestBuilder 

Source 
pub struct RequestBuilder<'a, S, Response> { /* private fields */ }
Expand description

A builder to construct the properties of a Request.

Constructed using HttpClientExt.

Implementations§

Source§

impl<S, Body> RequestBuilder<'_, S, Response<Body>>
where S: Service<Request, Output = Response<Body>, Error: Into<BoxError>>,

Source

pub fn header<K, V>(self, key: K, value: V) -> Self
where K: IntoHeaderName, V: IntoHeaderValue,

Add a Header to this Request.

Source

pub fn typed_header<H>(self, header: H) -> Self
where H: HeaderEncode,

Add a typed HeaderEncode to this Request.

Source

pub fn headers(self, headers: HeaderMap) -> Self

Add all Headers from the HeaderMap to this Request.

Source

pub fn overwrite_header<K, V>(self, key: K, value: V) -> Self
where K: IntoHeaderName, V: IntoHeaderValue,

Overwrite a Header to this Request.

Source

pub fn overwrite_typed_header<H>(self, header: H) -> Self
where H: HeaderEncode,

Overwrite a typed HeaderEncode to this Request.

Source

pub fn auth(self, credentials: impl Credentials) -> Self

Enable HTTP authentication.

Source

pub fn extension<T>(self, extension: T) -> Self
where T: Extension,

Adds an extension to this builder

Source

pub fn extensions(&self) -> Option<&Extensions>

Get access to the underlying Extensions

This function will return None if Extensions are not available, or if this builder is in an error state

Source

pub fn body<T>(self, body: T) -> Self
where T: TryInto<Body, Error: Into<BoxError>>,

Set the Request’s Body.

Re-syncs Content-Length with the new body: when the body has a known exact size, Content-Length is set to that value, replacing any prior value. When the size is unknown, any pre-set Content-Length is removed so the request doesn’t ship with stale framing.

Source

pub fn form<T: Serialize + ?Sized>(self, form: &T) -> Self

Set the given value as a URL-Encoded Form Body in the Request.

Sets Content-Type: application/x-www-form-urlencoded if no Content-Type header is already set. Sets Content-Length to the encoded body’s size, replacing any prior value.

Source

pub fn json<T: Serialize + ?Sized>(self, json: &T) -> Self

Set the given value as a JSON Body in the Request.

Sets Content-Type: application/json if no Content-Type header is already set. Sets Content-Length to the encoded body’s size, replacing any prior value.

Source

pub fn multipart(self, form: Form) -> Self

Available on crate feature multipart only.

Set a multipart::Form as the body of this Request.

Sets the Content-Type header to multipart/form-data; boundary={boundary} and, when every part has a known size, the Content-Length header. An existing Content-Type header is overwritten.

Source

pub fn octet_stream<T: Into<Bytes>>(self, bytes: T) -> Self

Set the given bytes as an application/octet-stream Body in the Request.

Sets Content-Type: application/octet-stream if no Content-Type header is already set on the request. Sets Content-Length to the payload’s size, replacing any prior value.

Source

pub fn version(self, version: Version) -> Self

Set the http Version of this Request.

Source

pub async fn try_into_request(self) -> Result<Request, BoxError>

Constructs the Request.

§Errors

This method fails if there was an error while constructing the Request.

Source

pub async fn send(self) -> Result<Response<Body>, BoxError>

Constructs the Request and sends it to the target Uri, returning a future Response.

§Errors

This method fails if there was an error while sending Request.

Trait Implementations§

Source§

impl<S, Response> Debug for RequestBuilder<'_, S, Response>
where S: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, S, Response> !RefUnwindSafe for RequestBuilder<'a, S, Response>

§

impl<'a, S, Response> !UnwindSafe for RequestBuilder<'a, S, Response>

§

impl<'a, S, Response> Freeze for RequestBuilder<'a, S, Response>

§

impl<'a, S, Response> Send for RequestBuilder<'a, S, Response>
where S: Sync,

§

impl<'a, S, Response> Sync for RequestBuilder<'a, S, Response>
where S: Sync,

§

impl<'a, S, Response> Unpin for RequestBuilder<'a, S, Response>

§

impl<'a, S, Response> UnsafeUnpin for RequestBuilder<'a, S, Response>

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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<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<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, U> RamaFrom<T> for U
where U: From<T>,

Source§

fn rama_from(value: T) -> U

Source§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

Source§

fn rama_into(self) -> U

Source§

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

Source§

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

Source§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

Source§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

Source§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

Source§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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