Skip to main content

RequestBuilder

rama::http::service::client

Struct RequestBuilder 

pub struct RequestBuilder<'a, S, Response> { /* private fields */ }
Available on crate features http and std only.
Expand description

A builder to construct the properties of a Request.

Constructed using HttpClientExt.

Implementations§

§

impl<S, Body> RequestBuilder<'_, S, Response<Body>>
where S: Service<Request, Output = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

pub fn header<K, V>( self, key: K, value: V, ) -> RequestBuilder<'_, S, Response<Body>>
where K: IntoHeaderName, V: IntoHeaderValue,

Add a Header to this Request.

pub fn typed_header<H>(self, header: H) -> RequestBuilder<'_, S, Response<Body>>
where H: HeaderEncode,

Add a typed HeaderEncode to this Request.

pub fn headers( self, headers: HeaderMap, ) -> RequestBuilder<'_, S, Response<Body>>

Add all Headers from the HeaderMap to this Request.

pub fn overwrite_header<K, V>( self, key: K, value: V, ) -> RequestBuilder<'_, S, Response<Body>>
where K: IntoHeaderName, V: IntoHeaderValue,

Overwrite a Header to this Request.

pub fn overwrite_typed_header<H>( self, header: H, ) -> RequestBuilder<'_, S, Response<Body>>
where H: HeaderEncode,

Overwrite a typed HeaderEncode to this Request.

pub fn auth( self, credentials: impl Credentials, ) -> RequestBuilder<'_, S, Response<Body>>

Enable HTTP authentication.

pub fn extension<T>(self, extension: T) -> RequestBuilder<'_, S, Response<Body>>
where T: Extension,

Adds an extension to this builder

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

pub fn body<T>(self, body: T) -> RequestBuilder<'_, S, Response<Body>>
where T: TryInto<Body>, <T as TryInto<Body>>::Error: Into<Box<dyn Error + Sync + Send>>,

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.

pub fn form<T>(self, form: &T) -> RequestBuilder<'_, S, Response<Body>>
where T: Serialize + ?Sized,

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.

pub fn json<T>(self, json: &T) -> RequestBuilder<'_, S, Response<Body>>
where T: Serialize + ?Sized,

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.

pub fn multipart(self, form: Form) -> RequestBuilder<'_, S, Response<Body>>

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.

pub fn octet_stream<T>(self, bytes: T) -> RequestBuilder<'_, S, Response<Body>>
where T: Into<Bytes>,

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.

pub fn version(self, version: Version) -> RequestBuilder<'_, S, Response<Body>>

Set the http Version of this Request.

pub async fn try_into_request( self, ) -> Result<Request, Box<dyn Error + Sync + Send>>

Constructs the Request.

§Errors

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

pub async fn send(self) -> Result<Response<Body>, Box<dyn Error + Sync + Send>>

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.

pub async fn send_with_timeout( self, t: Duration, ) -> Result<Response<Body>, Box<dyn Error + Sync + Send>>

Constructs the Request and sends it to the target Uri, returning a Response with a timeout that aborts with an error if the roundtrip does not complete in time.

Note that this does not apply to the collection of the response payload, if there is any at all. The roundtrip is considered complete after the response headers are received.

§Errors

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

Trait Implementations§

§

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

§

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

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
§

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

§

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

§

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

§

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
§

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

§

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.

§

impl<T> FutureExt for T

§

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

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

fn with_current_context(self) -> WithContext<Self> ⓘ

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

impl<T> Instrument for T

§

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

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

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
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

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
§

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
§

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

§

fn rama_from(value: T) -> U

§

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

§

fn rama_into(self) -> U

§

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

§

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

§

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

§

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

§

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

§

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

§

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.
§

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

§

fn vzip(self) -> V

§

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer
§

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

§

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer
§

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

§

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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