Struct BodyBuilder

pub struct BodyBuilder { /* private fields */ }

Expand description

Builder for creating a response body.

This is useful for testing, or for Middleware that returns another body than the requested one.

§Example

use ureq::Body;
use http::Response;

let body = Body::builder()
    .mime_type("text/plain")
    .charset("utf-8")
    .data("Hello world!");

let mut response = Response::builder()
    .status(200)
    .header("content-type", "text/plain; charset=utf-8")
    .body(body)?;

let text = response
    .body_mut()
    .read_to_string()?;

assert_eq!(text, "Hello world!");

Implementations§

impl BodyBuilder

pub fn mime_type(self, mime_type: impl Into<String>) -> Self

Set the mime type of the body.

This does not set any HTTP headers. Affects Body decoding.

use ureq::Body;

let body = Body::builder()
    .mime_type("text/plain")
    .data("Hello world!");

pub fn charset(self, charset: impl Into<String>) -> Self

Set the mime type of the body

This does not set any HTTP headers. Affects Body decoding.

use ureq::Body;

let body = Body::builder()
    .mime_type("text/plain")
    .charset("utf-8")
    .data("Hello world!");

pub fn limit(self, l: u64) -> Self

Limit how much data is to be released from the body.

This does not set any HTTP headers. Affects Body decoding.

use ureq::Body;

let body = Body::builder()
    .mime_type("text/plain")
    .charset("utf-8")
    .limit(5)
    // This will be limited to "Hello"
    .data("Hello world!");

pub fn data(self, data: impl Into<Vec<u8>>) -> Body

Creates the body data turned into bytes.

Will automatically limit the body reader to the lenth of the data.

pub fn reader(self, data: impl Read + Send + Sync + 'static) -> Body

Creates a body from a streaming reader.

The reader can be limited by using .limit() or that the reader reaches the end.

Auto Trait Implementations§

impl Freeze for BodyBuilder

impl RefUnwindSafe for BodyBuilder

impl Send for BodyBuilder

impl Sync for BodyBuilder

impl Unpin for BodyBuilder

impl UnwindSafe for BodyBuilder

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

fn from(t: T) -> T

Returns the argument unchanged.

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