devela::_dep::ureq

Struct Body

Help

pub struct Body { /* private fields */ }

Available on crate feature dep_ureq only.

Expand description

A response body returned as http::Response<Body>.

§Body lengths

HTTP/1.1 has two major modes of transfering body data. Either a Content-Length header defines exactly how many bytes to transfer, or Transfer-Encoding: chunked facilitates a streaming style when the size is not known up front.

To protect against a problem called request smuggling, ureq has heuristics for how to interpret a server sending both Transfer-Encoding and Content-Length headers.

chunked takes precedence if there both headers are present (not for HTTP/1.0)
content-length is used if there is no chunked
If there are no headers, fall back on “close delimited” meaning the socket must close to end the body

When a Content-Length header is used, ureq will ensure the received body is EXACTLY as many bytes as declared (it cannot be less). This mechanic is in ureq-proto and is different to the BodyWithConfig::limit() below.

§Pool reuse

To return a connection (aka Transport) to the Agent’s pool, the body must be read to end. If BodyWithConfig::limit() is set shorter size than the actual response body, the connection will not be reused.

§Example

use std::io::Read;
let mut res = ureq::get("http://httpbin.org/bytes/100")
    .call()?;

assert!(res.headers().contains_key("Content-Length"));
let len: usize = res.headers().get("Content-Length")
    .unwrap().to_str().unwrap().parse().unwrap();

let mut bytes: Vec<u8> = Vec::with_capacity(len);
res.body_mut().as_reader()
    .read_to_end(&mut bytes)?;

assert_eq!(bytes.len(), len);

Implementations§

§

impl Body

pub fn builder() -> BodyBuilder

Builder for creating a body

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

pub fn mime_type(&self) -> Option<&str> ⓘ

The mime-type of the content-type header.

For the below header, we would get Some("text/plain"):

    Content-Type: text/plain; charset=iso-8859-1

Caution: A bad server might set Content-Type to one thing and send something else. There is no way ureq can verify this.

§Example

let res = ureq::get("https://www.google.com/")
    .call()?;

assert_eq!(res.body().mime_type(), Some("text/html"));

pub fn charset(&self) -> Option<&str> ⓘ

The charset of the content-type header.

For the below header, we would get Some("iso-8859-1"):

    Content-Type: text/plain; charset=iso-8859-1

Caution: A bad server might set Content-Type to one thing and send something else. There is no way ureq can verify this.

§Example

let res = ureq::get("https://www.google.com/")
    .call()?;

assert_eq!(res.body().charset(), Some("ISO-8859-1"));

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

The content length of the body.

This is the value of the Content-Length header, if there is one. For chunked responses (Transfer-Encoding: chunked) , this will be None. Similarly for HTTP/1.0 without a Content-Length header, the response is close delimited, which means the length is unknown.

A bad server might set Content-Length to one thing and send something else. ureq will double check this, see section on body length heuristics.

§Example

let res = ureq::get("https://httpbin.org/bytes/100")
    .call()?;

assert_eq!(res.body().content_length(), Some(100));

pub fn as_reader(&mut self) -> BodyReader<'_> ⓘ

Handle this body as a shared impl Read of the body.

This is the regular API which goes via http::Response::body_mut() to get a mut reference to the Body, and then use as_reader(). It is also possible to get a non-shared, owned reader via Body::into_reader().

Reader is not limited. To set a limit use Body::with_config().

§Example

use std::io::Read;

let mut res = ureq::get("http://httpbin.org/bytes/100")
    .call()?;

let mut bytes: Vec<u8> = Vec::with_capacity(1000);
res.body_mut().as_reader()
    .read_to_end(&mut bytes)?;

pub fn into_reader(self) -> BodyReader<'static> ⓘ

Turn this response into an owned impl Read of the body.

Sometimes it might be useful to disconnect the body reader from the body. The reader returned by Body::as_reader() borrows the body, while this variant consumes the body and turns it into a reader with lifetime 'static. The reader can for instance be sent to another thread.

Reader is not limited. To set a limit use Body::into_with_config().

use std::io::Read;

let res = ureq::get("http://httpbin.org/bytes/100")
    .call()?;

let (_, body) = res.into_parts();

let mut bytes: Vec<u8> = Vec::with_capacity(1000);
body.into_reader()
    .read_to_end(&mut bytes)?;

pub fn read_to_string(&mut self) -> Result<String, Error> ⓘ

Read the response as a string.

Response is limited to 10MB
Replaces incorrect utf-8 chars to ?

To change these defaults use Body::with_config().

let mut res = ureq::get("http://httpbin.org/robots.txt")
    .call()?;

let s = res.body_mut().read_to_string()?;
assert_eq!(s, "User-agent: *\nDisallow: /deny\n");

pub fn read_to_vec(&mut self) -> Result<Vec<u8>, Error> ⓘ

Read the response to a vec.

Response is limited to 10MB.

To change this default use Body::with_config().

let mut res = ureq::get("http://httpbin.org/bytes/100")
    .call()?;

let bytes = res.body_mut().read_to_vec()?;
assert_eq!(bytes.len(), 100);

pub fn with_config(&mut self) -> BodyWithConfig<'_>

Read the body data with configuration.

This borrows the body which gives easier use with http::Response::body_mut(). To get a non-borrowed reader use Body::into_with_config().

§Example

let reader = ureq::get("http://httpbin.org/bytes/100")
    .call()?
    .body_mut()
    .with_config()
    // Reader will only read 50 bytes
    .limit(50)
    .reader();

pub fn into_with_config(self) -> BodyWithConfig<'static>

Consume self and read the body with configuration.

This consumes self and returns a reader with 'static lifetime.

§Example

// Get the body out of http::Response
let (_, body) = ureq::get("http://httpbin.org/bytes/100")
    .call()?
    .into_parts();

let reader = body
    .into_with_config()
    // Reader will only read 50 bytes
    .limit(50)
    .reader();

Trait Implementations§

§

impl Debug for Body

§

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

Formats the value using the given formatter. Read more

§

impl AsSendBody for Body

Auto Trait Implementations§

§

Struct BodyCopy item path

§Body lengths

§Pool reuse

§Example

Implementations§

impl Body

pub fn builder() -> BodyBuilder

pub fn mime_type(&self) -> Option<&str> ⓘ

§Example

pub fn charset(&self) -> Option<&str> ⓘ

§Example

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

§Example

pub fn as_reader(&mut self) -> BodyReader<'_> ⓘ

§Example

pub fn into_reader(self) -> BodyReader<'static> ⓘ

pub fn read_to_string(&mut self) -> Result<String, Error> ⓘ

pub fn read_to_vec(&mut self) -> Result<Vec<u8>, Error> ⓘ

pub fn with_config(&mut self) -> BodyWithConfig<'_>

§Example

pub fn into_with_config(self) -> BodyWithConfig<'static>

§Example

Trait Implementations§

impl Debug for Body

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

impl AsSendBody for Body

Auto Trait Implementations§

impl !Freeze for Body

impl !RefUnwindSafe for Body

impl Send for Body

impl Sync for Body

impl Unpin for Body

impl !UnwindSafe for Body

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize

fn byte_size(&self) -> usize

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T, R> Chain<R> for Twhere T: ?Sized,

fn chain<F>(self, f: F) -> Rwhere F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> Rwhere F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> Rwhere F: FnOnce(&mut Self) -> R,

impl<T> ExtAny for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn type_hash(&self) -> u64

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

impl<T> ExtMem for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize

fn mem_align_of_val(&self) -> usize

fn mem_size_of<T>() -> usize

fn mem_size_of_val(&self) -> usize

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

fn mem_drop(self)where Self: Sized,

fn mem_forget(self)where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Selfwhere Self: Sized,

fn mem_take(&mut self) -> Selfwhere Self: Default,

fn mem_swap(&mut self, other: &mut Self)where Self: Sized,

unsafe fn mem_zeroed<T>() -> T

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

fn mem_as_bytes(&self) -> &[u8] ⓘwhere Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘwhere Self: Sync + Unpin,

impl<T> From<T> for T

Struct Body

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T> ExtAny for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> ExtMem for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

impl<T> Ungil for T
where T: Send,