pub struct SdkBody { /* private fields */ }
Expand description
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§
Source§impl SdkBody
impl SdkBody
Sourcepub fn from_body_0_4<T, E>(body: T) -> Self
Available on crate feature http-body-0-4-x
only.
pub fn from_body_0_4<T, E>(body: T) -> Self
http-body-0-4-x
only.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.
Source§impl SdkBody
impl SdkBody
Sourcepub fn from_body_1_x<T, E>(body: T) -> Self
Available on crate feature http-body-1-x
only.
pub fn from_body_1_x<T, E>(body: T) -> Self
http-body-1-x
only.Construct an SdkBody
from a type that implements http_body_1_0::Body<Data = Bytes>
.
Source§impl SdkBody
impl SdkBody
Sourcepub fn retryable(f: impl Fn() -> SdkBody + Send + Sync + 'static) -> Self
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.
Sourcepub fn taken() -> Self
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.
Sourcepub fn empty() -> Self
pub fn empty() -> Self
Create an empty SdkBody for requests and responses that don’t transfer any data in the body.
Sourcepub fn bytes(&self) -> Option<&[u8]>
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
Sourcepub fn try_clone(&self) -> Option<Self>
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.
Sourcepub fn is_streaming(&self) -> bool
pub fn is_streaming(&self) -> bool
Return true
if this SdkBody is streaming, false
if it is in-memory.
Sourcepub fn content_length(&self) -> Option<u64>
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.
Sourcepub fn map(
self,
f: impl Fn(SdkBody) -> SdkBody + Sync + Send + 'static,
) -> SdkBody
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.
Sourcepub fn map_preserve_contents(
self,
f: impl Fn(SdkBody) -> SdkBody + Sync + Send + 'static,
) -> SdkBody
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§
Source§impl Body for SdkBody
Available on crate feature http-body-0-4-x
only.
impl Body for SdkBody
http-body-0-4-x
only.Source§fn poll_data(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Option<Result<Self::Data, Self::Error>>>
fn poll_data( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Self::Data, Self::Error>>>
Source§fn poll_trailers(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
) -> Poll<Result<Option<HeaderMap<HeaderValue>>, Self::Error>>
fn poll_trailers( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, Self::Error>>
HeaderMap
of trailers. Read moreSource§fn is_end_stream(&self) -> bool
fn is_end_stream(&self) -> bool
true
when the end of stream has been reached. Read moreSource§fn size_hint(&self) -> SizeHint
fn size_hint(&self) -> SizeHint
Source§fn trailers(&mut self) -> Trailers<'_, Self>
fn trailers(&mut self) -> Trailers<'_, Self>
Source§fn map_data<F, B>(self, f: F) -> MapData<Self, F>
fn map_data<F, B>(self, f: F) -> MapData<Self, F>
Source§fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
Source§fn collect(self) -> Collect<Self>where
Self: Sized,
fn collect(self) -> Collect<Self>where
Self: Sized,
Collected
body which will collect all the DATA frames
and trailers.Source§fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
Source§impl Body for SdkBody
Available on crate feature http-body-1-x
only.
impl Body for SdkBody
http-body-1-x
only.Source§impl From<Body> for SdkBody
Available on crate features http-body-0-4-x
and hyper-0-14-x
only.
impl From<Body> for SdkBody
http-body-0-4-x
and hyper-0-14-x
only.Source§impl From<SdkBody> for ByteStream
impl From<SdkBody> for ByteStream
impl<'__pin> Unpin for SdkBodywhere
PinnedFieldsOf<__Origin<'__pin>>: Unpin,
Auto Trait Implementations§
impl !Freeze for SdkBody
impl !RefUnwindSafe for SdkBody
impl Send for SdkBody
impl Sync for SdkBody
impl !UnwindSafe for SdkBody
Blanket Implementations§
Source§impl<T> BodyExt for T
impl<T> BodyExt for T
Source§fn frame(&mut self) -> Frame<'_, Self>where
Self: Unpin,
fn frame(&mut self) -> Frame<'_, Self>where
Self: Unpin,
Frame
, if any.Source§fn map_frame<F, B>(self, f: F) -> MapFrame<Self, F>
fn map_frame<F, B>(self, f: F) -> MapFrame<Self, F>
Source§fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
fn map_err<F, E>(self, f: F) -> MapErr<Self, F>
Source§fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error>
Source§fn collect(self) -> Collect<Self>where
Self: Sized,
fn collect(self) -> Collect<Self>where
Self: Sized,
Collected
body which will collect all the DATA frames
and trailers.Source§fn with_trailers<F>(self, trailers: F) -> WithTrailers<Self, F>
fn with_trailers<F>(self, trailers: F) -> WithTrailers<Self, F>
Source§fn into_data_stream(self) -> BodyDataStream<Self>where
Self: Sized,
fn into_data_stream(self) -> BodyDataStream<Self>where
Self: Sized,
BodyDataStream
.Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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