Struct solarsail::body::Body

pub struct Body(_);

The body of a HTTP request and response. It is internally based on hyper::Body, but adds convenient methods around reading the body into certain formats. A body can only be read once. Once read, each subsequent attempt to read the body will return a BodyError::AlreadyRead.

Implementations

impl Body

pub fn empty() -> Self

Create an empty Body.

pub fn with_limit(&mut self, limit: usize) -> &mut Self

Creates a new Body with the given limit set. The limit restricts the reading of a request body with a content-length (header) greater the limit. The default limit is set to one 1MiB.

Example

let mut req = http::Request::builder().body(Body::from(vec![0; 16]))?;
assert!(matches!(req.body_mut().with_limit(8).bytes().await, Err(BodyError::MaxSize)));

pub fn take(&mut self) -> Result<(Body, Option<Mime>), BodyError>

pub async fn json<T: DeserializeOwned>(&mut self) -> Result<T, BodyError>

Reads and deserializes the whole body as JSON.

Example

let mut req = http::Request::builder().body(Body::from(r#"{"name":"SolarSail"}"#))?;
#[derive(Deserialize)]
struct Info {
  name: String,
}
let info: Info = req.body_mut().json().await?;
assert_eq!(&info.name, "SolarSail");

pub async fn bytes(&mut self) -> Result<impl Buf, BodyError>

Reads the whole body as raw bytes.

Example

let mut req = http::Request::builder().body(Body::from(&b"SolarSail"[..]))?;
let mut buf = req.body_mut().bytes().await?;
let bytes = buf.copy_to_bytes(9);
assert_eq!(&bytes[..], &b"SolarSail"[..]);

pub async fn multipart(&mut self) -> Result<Multipart<'_>, BodyError>

pub async fn multipart_with_constraints(
    &mut self,
    constraints: Constraints
) -> Result<Multipart<'_>, BodyError>

Trait Implementations

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

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

Performs the conversion.

impl From<&'static str> for Body

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

Performs the conversion.

impl From<String> for Body

fn from(data: String) -> Self

Performs the conversion.

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

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

Performs the conversion.