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§

§

impl SdkBody

pub fn from_dyn( body: BoxBody<Bytes, Box<dyn Error + Sync + Send, Global>> ) -> SdkBody

Construct an SdkBody from a Boxed implementation of http::Body

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

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() -> SdkBody

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() -> SdkBody

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

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

Trait Implementations§

§

impl Body for SdkBody

§

type Data = Bytes

Values yielded by the Body.
§

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

The error type this Body might generate.
§

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

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

fn poll_trailers( self: Pin<&mut SdkBody>, _cx: &mut Context<'_> ) -> Poll<Result<Option<HeaderMap<HeaderValue>>, <SdkBody as Body>::Error>>

Poll for an optional single HeaderMap of trailers. Read more
§

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached. Read more
§

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream. Read more
source§

fn data(&mut self) -> Data<'_, Self>where Self: Unpin + Sized,

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

fn trailers(&mut self) -> Trailers<'_, Self>where Self: Unpin + Sized,

Returns future that resolves to trailers, if any.
source§

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.
source§

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.
source§

fn boxed(self) -> BoxBody<Self::Data, Self::Error>where Self: Sized + Send + Sync + 'static,

Turn this body into a boxed trait object.
source§

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

§

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

Formats the value using the given formatter. Read more
§

impl From<&[u8]> for SdkBody

§

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

Converts to this type from the input type.
§

impl From<&str> for SdkBody

§

fn from(s: &str) -> SdkBody

Converts to this type from the input type.
§

impl From<Body> for SdkBody

§

fn from(body: Body) -> SdkBody

Converts to this type from the input type.
§

impl From<Bytes> for SdkBody

§

fn from(bytes: Bytes) -> SdkBody

Converts to this type from the input type.
§

impl From<SdkBody> for ByteStream

§

fn from(inp: SdkBody) -> ByteStream

Converts to this type from the input type.
§

impl From<String> for SdkBody

§

fn from(s: String) -> SdkBody

Converts to this type from the input type.
§

impl From<Vec<u8, Global>> for SdkBody

§

fn from(data: Vec<u8, Global>) -> SdkBody

Converts to this type from the input type.
§

impl<'__pin> Unpin for SdkBodywhere __Origin<'__pin>: Unpin,

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere 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> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more