Struct Body 

pub struct Body(/* private fields */);

An request body.

Implementations

impl Body

pub fn as_bytes(&self) -> Option<&[u8]>

Returns a reference to the internal data of the Body.

None is returned, if the underlying data is a stream.

pub fn wrap<B>(inner: B) -> Body

where B: HttpBody + Send + Sync + 'static, B::Data: Into<Bytes>, B::Error: Into<Box<dyn StdError + Send + Sync>>,

Wrap a HttpBody in a box inside Body.

Example

let content = "hello,world!".to_string();

let body = Body::wrap(content);

pub fn wrap_stream<S>(stream: S) -> Body

where S: TryStream + Send + 'static, S::Error: Into<Box<dyn StdError + Send + Sync>>, Bytes: From<S::Ok>,

Available on crate feature stream only.

Wrap a futures Stream in a box inside Body.

Example

let chunks: Vec<Result<_, ::std::io::Error>> = vec![Ok("hello"), Ok(" "), Ok("world")];

let stream = futures_util::stream::iter(chunks);

let body = Body::wrap_stream(stream);

Optional

This requires the stream feature to be enabled.

pub fn into_bytes_mut(self) -> Option<BytesMut>

Convert the body into a mutable bytes::BytesMut if possible.

This is useful for zero-copy operations where you need a mutable buffer, such as with SIMD JSON parsing.

Returns Some(BytesMut) if the body is a reusable Bytes chunk, None if the body is a streaming body.

Example

use bytes::BytesMut;
use hpx::Body;

let body = Body::from("hello world");
if let Some(bytes_mut) = body.into_bytes_mut() {
    // Use mutable bytes for zero-copy operations
    println!("Got {} bytes", bytes_mut.len());
}

pub fn reader(self) -> impl AsyncRead

Available on crate feature stream only.

Get an tokio::io::AsyncRead adapter for the body.

This enables efficient streaming of the body using standard async I/O traits.

Example

use hpx::Body;
use tokio::io::AsyncReadExt;

let body = Body::from("hello world");
let mut reader = body.reader();

let mut buffer = Vec::new();
reader.read_to_end(&mut buffer).await?;

Optional

This requires the optional stream feature to be enabled.

Trait Implementations

impl Body for Body

type Data = Bytes

Values yielded by the Body.

type Error = Error

The error type this Body might generate.

fn poll_frame( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Frame<Self::Data>, Self::Error>>>

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

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

fn is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Body

Returns the “default value” for a type.

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

fn from(s: &'static [u8]) -> Body

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(s: &'static str) -> Body

Converts to this type from the input type.

impl From<BoxBody<Bytes, Box<dyn Error + Send + Sync>>> for Body

fn from(body: BoxBody<Bytes, Box<dyn StdError + Send + Sync>>) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(bytes: Bytes) -> Body

Converts to this type from the input type.

impl From<File> for Body

Available on crate feature stream only.

fn from(file: File) -> Body

Converts to this type from the input type.

impl From<Response> for Body

A Response can be piped as the Body of another request.

fn from(r: Response) -> Body

Converts to this type from the input type.

impl From<String> for Body

fn from(s: String) -> Body

Converts to this type from the input type.

impl From<Vec<u8>> for Body

fn from(vec: Vec<u8>) -> Body

Converts to this type from the input type.