Struct SdkBody

pub struct SdkBody { /* private fields */ }

SdkBody type

This is the Body used for dispatching all HTTP Requests. For handling responses, the type of the body will be controlled by the HTTP stack.

Implementations

impl SdkBody

pub fn from_body_0_4<T, E>(body: T) -> Self

where T: Body<Data = Bytes, Error = E> + Send + Sync + 'static, E: Into<Error> + 'static,

Construct an SdkBody from a type that implements http_body_0_4::Body<Data = Bytes>.

Note: This is only available with http-body-0-4-x enabled.

impl SdkBody

pub fn from_body_1_x<T, E>(body: T) -> Self

where T: Body<Data = Bytes, Error = E> + Send + Sync + 'static, E: Into<Error> + 'static,

Construct an SdkBody from a type that implements http_body_1_0::Body<Data = Bytes>.

impl SdkBody

pub fn retryable(f: impl Fn() -> SdkBody + Send + Sync + 'static) -> Self

Construct an explicitly retryable SDK body

Note: This is probably not what you want

All bodies constructed from in-memory data (String, Vec<u8>, Bytes, etc.) will be retryable out of the box. If you want to read data from a file, you should use ByteStream::from_path. This function is only necessary when you need to enable retries for your own streaming container.

pub fn taken() -> Self

When an SdkBody is read, the inner data must be consumed. In order to do this, the SdkBody is swapped with a “taken” body. This “taken” body cannot be read but aids in debugging.

pub fn empty() -> Self

Create an empty SdkBody for requests and responses that don’t transfer any data in the body.

pub fn bytes(&self) -> Option<&[u8]>

If possible, return a reference to this body as &[u8]

If this SdkBody is NOT streaming, this will return the byte slab If this SdkBody is streaming, this will return None

pub fn try_clone(&self) -> Option<Self>

Attempt to clone this SdkBody. This will fail if the inner data is not cloneable, such as when it is a single-use stream that can’t be recreated.

pub fn is_streaming(&self) -> bool

Return true if this SdkBody is streaming, false if it is in-memory.

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

Return the length, in bytes, of this SdkBody. If this returns None, then the body does not have a known length.

pub fn map( self, f: impl Fn(SdkBody) -> SdkBody + Sync + Send + 'static, ) -> SdkBody

Given a function to modify an SdkBody, run that function against this SdkBody before returning the result.

pub fn map_preserve_contents( self, f: impl Fn(SdkBody) -> SdkBody + Sync + Send + 'static, ) -> SdkBody

Update this SdkBody with map. This function MUST NOT alter the data of the body.

This function is useful for adding metadata like progress tracking to an SdkBody that does not alter the actual byte data. If your mapper alters the contents of the body, use SdkBody::map instead.

Trait Implementations

impl Body for SdkBody

type Data = Bytes

Values yielded by the Body.

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

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<HeaderValue>>, 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 SdkBody

type Data = Bytes

Values yielded by the Body.

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

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 Debug for SdkBody

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

Formats the value using the given formatter.

impl From<&[u8]> for SdkBody

fn from(data: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for SdkBody

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for SdkBody

fn from(bytes: Bytes) -> Self

Converts to this type from the input type.

impl From<SdkBody> for ByteStream

fn from(inp: SdkBody) -> Self

Converts to this type from the input type.

impl From<String> for SdkBody

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for SdkBody

fn from(data: Vec<u8>) -> Self

Converts to this type from the input type.

impl<'__pin> Unpin for SdkBody

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