Skip to main content

BodyBytes

product_os_server

Struct BodyBytes

pub struct BodyBytes { /* private fields */ }

Expand description

A concrete implementation of an HTTP body.

BodyBytes is an enum-backed type that can represent various kinds of HTTP bodies:

Empty bodies
Full bodies with all data available upfront
Streaming bodies from various sources
Collected bodies
Boxed bodies for type erasure

§Examples

§Creating an empty body

use product_os_http_body::BodyBytes;

let body = BodyBytes::empty();

§Creating a body from bytes

use product_os_http_body::{BodyBytes, Bytes};

let body = BodyBytes::new(Bytes::from("Hello, World!"));

§Creating a body from a string

use product_os_http_body::BodyBytes;

let body = BodyBytes::from("string data");
let body2 = BodyBytes::from(String::from("owned string"));

§Feature-gated functionality

Some constructors and conversions are only available with specific features:

stream: Enables new_stream() and from_stream() for streaming bodies
box_body: Enables conversions from BoxBody
incoming: Enables conversions from hyper::body::Incoming

§Body trait implementation

BodyBytes implements the http_body::Body trait (when the std feature is enabled), allowing it to be used anywhere an HTTP body is expected.

Implementations§

impl BodyBytes

pub fn empty() -> BodyBytes

pub fn new(bytes: Bytes) -> BodyBytes

pub async fn convert_to_bytes(self) -> Result<Bytes, BodyError>

pub async fn as_bytes(&mut self) -> Result<Bytes, BodyError>

Trait Implementations§

impl Body for BodyBytes

type Data = Bytes

Values yielded by the Body.

type Error = BodyError

The error type this Body might generate.

fn poll_frame( self: Pin<&mut BodyBytes>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<<BodyBytes as Body>::Data>, <BodyBytes as Body>::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. Read more

fn size_hint(&self) -> SizeHint

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

impl Clone for BodyBytes

fn clone(&self) -> BodyBytes

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for BodyBytes

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

Formats the value using the given formatter. Read more

impl Default for BodyBytes

fn default() -> BodyBytes

Returns the “default value” for a type. Read more

impl From<&'static [u8]> for BodyBytes

fn from(value: &'static [u8]) -> BodyBytes

Converts to this type from the input type.

impl From<&'static str> for BodyBytes

fn from(value: &'static str) -> BodyBytes

Converts to this type from the input type.

impl From<Bytes> for BodyBytes

fn from(value: Bytes) -> BodyBytes

Converts to this type from the input type.

impl From<Collected<Bytes>> for BodyBytes

fn from(value: Collected<Bytes>) -> BodyBytes

Converts to this type from the input type.

impl From<Empty<Bytes>> for BodyBytes

fn from(value: Empty<Bytes>) -> BodyBytes

Converts to this type from the input type.

impl From<Full<Bytes>> for BodyBytes

fn from(value: Full<Bytes>) -> BodyBytes

Converts to this type from the input type.

impl<T> From<Request<T>> for BodyBytes
where T: Into<BodyBytes>,

fn from(value: Request<T>) -> BodyBytes

Converts to this type from the input type.

impl<T> From<Response<T>> for BodyBytes
where T: Into<BodyBytes>,

fn from(value: Response<T>) -> BodyBytes

Converts to this type from the input type.

impl From<String> for BodyBytes

fn from(value: String) -> BodyBytes

Converts to this type from the input type.

impl From<Vec<u8>> for BodyBytes

fn from(value: Vec<u8>) -> BodyBytes

Converts to this type from the input type.

impl IntoResponse for BodyBytes

Available on crate feature axum only.

fn into_response(self) -> Response<Body>

Create a response.

Auto Trait Implementations§

impl !Freeze for BodyBytes

impl RefUnwindSafe for BodyBytes

impl Send for BodyBytes

impl Sync for BodyBytes

impl Unpin for BodyBytes

impl UnsafeUnpin for BodyBytes

impl UnwindSafe for BodyBytes

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> BodyExt for T
where T: Body + ?Sized,

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

Returns a future that resolves to the next Frame, if any.

fn map_frame<F, B>(self, f: F) -> MapFrame<Self, F>
where Self: Sized, F: FnMut(Frame<Self::Data>) -> Frame<B>, B: Buf,

Maps this body’s frame to a different kind.

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

fn collect(self) -> Collect<Self>
where Self: Sized,

Turn this body into Collected body which will collect all the DATA frames and trailers.

fn with_trailers<F>(self, trailers: F) -> WithTrailers<Self, F>
where Self: Sized, F: Future<Output = Option<Result<HeaderMap, Self::Error>>>,

Add trailers to the body. Read more

fn into_data_stream(self) -> BodyDataStream<Self>
where Self: Sized,

Turn this body into BodyDataStream.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromRef<T> for T
where T: Clone,

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

impl<T, S> Handler<IntoResponseHandler, S> for T
where T: IntoResponse + Clone + Send + Sync + 'static,

type Future = Ready<Response<Body>>

The type of future calling this handler returns.

fn call( self, _req: Request<Body>, _state: S, ) -> <T as Handler<IntoResponseHandler, S>>::Future

Call the handler with the given request.

fn layer<L>(self, layer: L) -> Layered<L, Self, T, S>
where L: Layer<HandlerService<Self, T, S>> + Clone, <L as Layer<HandlerService<Self, T, S>>>::Service: Service<Request<Body>>,

Apply a tower::Layer to the handler. Read more

fn with_state(self, state: S) -> HandlerService<Self, T, S>

Convert the handler into a Service by providing the state

impl<H, T> HandlerWithoutStateExt<T> for H
where H: Handler<T, ()>,

fn into_service(self) -> HandlerService<H, T, ()>

Convert the handler into a Service and no state.

fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, ()>>

Convert the handler into a MakeService and no state. Read more

fn into_make_service_with_connect_info<C>( self, ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, ()>, C>

Convert the handler into a MakeService which stores information about the incoming connection and has no state. Read more

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

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> Same for T

type Output = T

Should always be Self

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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.

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

Performs the conversion.

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

fn vzip(self) -> V

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