Struct CompressedBody

pub struct CompressedBody<InnerBody, CompressionImpl> { /* private fields */ }

A Body that may compress its data with a CompressRequest implementor.

Compression options may disable request compression for small data payload, or entirely. Additionally, some services may not support compression.

Implementations

impl CompressedBody<SdkBody, Box<dyn CompressRequest>>

pub fn into_compressed_sdk_body(self) -> Result<SdkBody, BoxError>

Consumes this CompressedBody and returns an [SdkBody] containing the compressed data.

This requires that the inner SdkBody is in-memory (i.e. not streaming). Otherwise, an error is returned. If compression fails, an error is returned.

impl<CR> CompressedBody<SdkBody, CR>

pub fn new(body: SdkBody, compress_request: CR) -> Self

Given an [SdkBody] and a Box<dyn CompressRequest>, create a new CompressedBody<SdkBody, CR>.

Trait Implementations

impl Body for CompressedBody<SdkBody, Box<dyn CompressRequest>>

type Data = Bytes

Values yielded by the Body.

type Error = Box<dyn Error + Sync + Send>

The error type this Body might generate.

fn poll_data( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Self::Data, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn poll_trailers( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<Option<HeaderMap>, Self::Error>>

Poll for an optional single HeaderMap of trailers.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn data(&mut self) -> Data<'_, Self>

where Self: Sized + Unpin,

Returns future that resolves to next data chunk, if any.

fn trailers(&mut self) -> Trailers<'_, Self>

where Self: Sized + Unpin,

Returns future that resolves to trailers, if any.

fn map_data<F, B>(self, f: F) -> MapData<Self, F>

where Self: Sized, F: FnMut(Self::Data) -> B, B: Buf,

Maps this body’s data value to a different value.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where Self: Sized, F: FnMut(Self::Error) -> E,

Maps this body’s error value to a different value.

fn collect(self) -> Collect<Self>

where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers.

fn boxed(self) -> BoxBody<Self::Data, Self::Error>

where Self: Sized + Send + Sync + 'static,

Turn this body into a boxed trait object.

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>

where Self: Sized + Send + 'static,

Turn this body into a boxed trait object that is !Sync.

impl Body for CompressedBody<SdkBody, Box<dyn CompressRequest>>

type Data = Bytes

Values yielded by the Body.

type Error = Box<dyn Error + Sync + Send>

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

Attempt to pull out the next data buffer of this stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

impl<'__pin, InnerBody, CompressionImpl> Unpin for CompressedBody<InnerBody, CompressionImpl>

where PinnedFieldsOf<__Origin<'__pin, InnerBody, CompressionImpl>>: Unpin,