Skip to main content

RequestBody

Enum RequestBody 

Source
pub enum RequestBody {
    Empty,
    Full(Bytes),
    Rewindable(RewindFactory),
    Streaming(Box<dyn Body<Data = Bytes, Error = Error> + Unpin + Send>),
}
Expand description

A request body with an explicit replay contract.

Variants§

§

Empty

§

Full(Bytes)

§

Rewindable(RewindFactory)

Replays by calling the factory.

Factory contract. It must be pure: every call must produce a body equivalent to the previous one (same content, same size). A factory with hidden state that hands back a different body on each call is a bug source that’s obvious in hindsight but undocumented otherwise, which is why size_hint() deliberately returns None for this variant: guessing from the first call is dangerous if the contract is violated.

The factory is legally allowed to return RequestBody::Streaming — that isn’t a live lie, because retry_kind() and rewind() are always recomputed from whatever object currently sits inside RequestBody, not cached at the moment Rewindable was created. Invariant that matters for the retry layer: always ask retry_kind() of the body you’re currently holding, and never cache it across a rewind().

§

Streaming(Box<dyn Body<Data = Bytes, Error = Error> + Unpin + Send>)

A single-pass body. The concrete stream is set by the transport; in v0.1 the core only needs to know it can’t be replayed.

+ Send — the same C2 exception as RewindFactory: Box<T>: Send requires only T: Send, Sync isn’t needed here.

Implementations§

Source§

impl RequestBody

Source

pub fn rewindable<F>(f: F) -> Self
where F: Fn() -> RequestBody + Send + Sync + 'static,

Source

pub fn retry_kind(&self) -> RetryKind

Source

pub fn rewind(&self) -> Option<RequestBody>

Source

pub fn size_hint(&self) -> Option<u64>

Trait Implementations§

Source§

impl Debug for RequestBody

Source§

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

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

impl Default for RequestBody

Source§

fn default() -> RequestBody

Returns the “default value” for a type. Read more

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