Struct BodyWithConfig

pub struct BodyWithConfig<'a> { /* private fields */ }

Expand description

Configuration of how to read the body.

Obtained via one of:

Implementations§

impl<'a> BodyWithConfig<'a>

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

Limit the response body.

Controls how many bytes we should read before throwing an error. This is used to ensure RAM isn’t exhausted by a server sending a very large response body.

The default limit is u64::MAX (unlimited).

pub fn lossy_utf8(self, value: bool) -> Self

Replace invalid utf-8 chars.

true means that broken utf-8 characters are replaced by a question mark ? (not utf-8 replacement char). This happens after charset conversion regardless of whether the charset feature is enabled or not.

The default is false.

pub fn reader(self) -> BodyReader<'a> ⓘ

Creates a reader.

The reader is either shared or owned, depending on with_config or into_with_config.

Consider:

// Creates an owned reader.
let reader = ureq::get("https://httpbin.org/get")
    .call()?
    .into_body()
    // takes ownership of Body
    .into_with_config()
    .limit(10)
    .reader();

// Creates a shared reader.
let reader = ureq::get("https://httpbin.org/get")
    .call()?
    .body_mut()
    // borrows Body
    .with_config()
    .limit(10)
    .reader();

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

Read into string.

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

Read into vector.

pub fn read_json<T: DeserializeOwned>(self) -> Result<T, Error>

Read JSON body.

Auto Trait Implementations§

impl<'a> !Freeze for BodyWithConfig<'a>

impl<'a> !RefUnwindSafe for BodyWithConfig<'a>

impl<'a> Send for BodyWithConfig<'a>

impl<'a> Sync for BodyWithConfig<'a>

impl<'a> Unpin for BodyWithConfig<'a>

impl<'a> !UnwindSafe for BodyWithConfig<'a>

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.

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> MaybeSendSync for T