Struct ResponseBody

Source

pub struct ResponseBody<'a>(/* private fields */);

Expand description

A response body received from a server

This type represents a body that will be read from the underlying transport

use trillium_client::Client;
use trillium_testing::{client_config, with_server};

with_server("hello from trillium", |url| async move {
    let client = Client::new(client_config());
    let mut conn = client.get(url).await?;
    let body = conn.response_body(); //<-
    assert_eq!(Some(19), body.content_length());
    assert_eq!("hello from trillium", body.read_string().await?);
    Ok(())
});

§Bounds checking

Every ResponseBody has a maximum length beyond which it will return an error, expressed as a u64. To override this on the specific ResponseBody, use ResponseBody::with_max_len or ResponseBody::set_max_len

Implementations§

Source §

impl ResponseBody<'_>

Source

pub async fn read_bytes(self) -> Result<Vec<u8>, Error>

Similar to ResponseBody::read_string, but returns the raw bytes. This is useful for bodies that are not text.

You can use this in conjunction with encoding if you need different handling of malformed character encoding than the lossy conversion provided by ResponseBody::read_string.

An empty or nonexistent body will yield an empty Vec, not an error.

§Errors

This will return an error if there is an IO error on the underlying transport such as a disconnect

This will also return an error if the length exceeds the maximum length. To configure the value on this specific request body, use ResponseBody::with_max_len or ResponseBody::set_max_len

Source

pub async fn read_string(self) -> Result<String, Error>

§Reads the entire body to `String`.

This uses the encoding determined by the content-type (mime) charset. If an encoding problem is encountered, the String returned by ResponseBody::read_string will contain utf8 replacement characters.

Note that this can only be performed once per Conn, as the underlying data is not cached anywhere. This is the only copy of the body contents.

An empty or nonexistent body will yield an empty String, not an error

§Errors

This will return an error if there is an IO error on the underlying transport such as a disconnect

This will also return an error if the length exceeds the maximum length. To configure the value on this specific response body, use ResponseBody::with_max_len or ResponseBody::set_max_len.

Source

pub fn with_max_len(self, max_len: u64) -> Self

Set the maximum content length to read, returning self

This protects against an memory-use denial-of-service attack wherein an untrusted peer sends an unbounded request body. This is especially important when using ResponseBody::read_string and ResponseBody::read_bytes instead of streaming with AsyncRead.

The default value can be found documented in the trillium-http crate

Source

pub fn set_max_len(&mut self, max_len: u64) -> &mut Self

Set the maximum content length to read

This protects against an memory-use denial-of-service attack wherein an untrusted peer sends an unbounded request body. This is especially important when using ResponseBody::read_string and ResponseBody::read_bytes instead of streaming with AsyncRead.

The default value can be found documented in the trillium-http crate

Source

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

The content-length of this body, if available.

This value usually is derived from the content-length header. If the request that this body is attached to uses transfer-encoding chunked, this will be None.