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.

TODO(naming): Consider renaming to simply Body, although I’m concerned about naming headaches between hyper::Body and our Body

Implementations

impl SdkBody

pub fn from_dyn(body: BoxBody) -> Self

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

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

pub fn empty() -> Self

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>

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

pub fn with_callback(&mut self, callback: Box<dyn BodyCallback>) -> &mut Self

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

Trait Implementations

impl Body for SdkBody

type Data = Bytes

Values yielded by the Body.

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

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

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

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

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

Returns future that resolves to trailers, if any.

fn map_data<F, B>(self, f: F) -> MapData<Self, F> where
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
F: FnMut(Self::Error) -> E,

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

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

Turn this body into a boxed trait object.

fn boxed_unsync(self) -> UnsyncBoxBody<Self::Data, Self::Error> where
Self: 'static + Send,

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

impl Debug for SdkBody

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

Formats the value using the given formatter. Read more

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

fn from(body: Body) -> 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, Global>> for SdkBody

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

Converts to this type from the input type.

impl<'pin> Unpin for SdkBody where
Origin<'__pin>: Unpin,

Auto Trait Implementations

impl !RefUnwindSafe for SdkBody

impl Send for SdkBody

impl Sync for SdkBody

impl !UnwindSafe for SdkBody

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · 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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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