Struct Body 

pub struct Body { /* private fields */ }

A type that represents an HTTP request or response body.

This type is used to represent the body of an HTTP request/response. It can be either a fixed body (e.g., a string or a byte array) or a streaming body (e.g., a large file or a database query result).

Examples

use cot::Body;

let body = Body::fixed("Hello, world!");
let body = Body::streaming(futures::stream::once(async { Ok("Hello, world!".into()) }));

Implementations

impl Body

pub const fn empty() -> Self

Create an empty body.

Examples

use cot::Body;

let body = Body::empty();

pub fn fixed<T: Into<Bytes>>(data: T) -> Self

Create a body instance with the given fixed data.

Examples

use cot::Body;

let body = Body::fixed("Hello, world!");

pub fn streaming<T: Stream<Item = Result<Bytes>> + Send + 'static>( stream: T, ) -> Self

Create a body instance from a stream of data.

Examples

use async_stream::stream;
use cot::Body;

let stream = stream! {
   yield Ok("Hello, ".into());
   yield Ok("world!".into());
};
let body = Body::streaming(stream);

pub async fn into_bytes(self) -> Result<Bytes>

Convert this Body instance into a byte array.

This method reads the entire body into memory and returns it as a byte array. Note that if the body is too large, this method can consume a lot of memory. For a way to read the body while limiting the memory usage, see Self::into_bytes_limited.

Errors

This method returns an error if reading the body fails.

Examples

use cot::Body;

let body = Body::fixed("Hello, world!");
let bytes = body.into_bytes().await?;
assert_eq!(bytes, "Hello, world!".as_bytes());

pub async fn into_bytes_limited(self, limit: usize) -> Result<Bytes>

Convert this Body instance into a byte array.

This is a version of Self::into_bytes that allows you to limit the amount of memory used to read the body. If the body is larger than the limit, an error is returned.

Errors

This method returns an error if reading the body fails.

If the body is larger than the limit, an error is returned.

Examples

use cot::Body;

let body = Body::fixed("Hello, world!");
let bytes = body.into_bytes_limited(32).await?;
assert_eq!(bytes, "Hello, world!".as_bytes());

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 is_end_stream(&self) -> bool

Returns true when the end of stream has been reached.

fn size_hint(&self) -> SizeHint

Returns the bounds on the remaining length of the stream.

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

fn default() -> Self

Returns the “default value” for a type.

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

fn from(buf: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<&'static str> for Body

fn from(buf: &'static str) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(buf: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(buf: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for Body

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

Converts to this type from the input type.

impl IntoResponse for Body

fn into_response(self) -> Result<Response>

Converts the implementing type into a cot::Result<Response>.

fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>

where K: TryInto<HeaderName>, V: TryInto<HeaderValue>, Self: Sized,

Modifies the response by appending the specified header.

fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>

where V: TryInto<HeaderValue>, Self: Sized,

Modifies the response by setting the Content-Type header.

fn with_status(self, status: StatusCode) -> WithStatus<Self>

where Self: Sized,

Modifies the response by setting the status code.

fn with_body(self, body: impl Into<Body>) -> WithBody<Self>

where Self: Sized,

Modifies the response by setting the body.

fn with_extension<T>(self, extension: T) -> WithExtension<Self, T>

where T: Clone + Send + Sync + 'static, Self: Sized,

Modifies the response by inserting an extension.