Struct aws_smithy_http::body::SdkBody
source · 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_dyn(body: BoxBody) -> Self
pub fn from_dyn(body: BoxBody) -> Self
Construct an SdkBody from a Boxed implementation of http::Body
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 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.
Trait Implementations§
source§impl Body for SdkBody
impl Body for SdkBody
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 more