Struct chttp::body::Body

pub struct Body(_);

Expand description

Contains the body of an HTTP request or response.

This type is used to encapsulate the underlying stream or region of memory where the contents of the body is stored. A Body can be created from many types of sources using the Into trait.

Implementations

impl Body

pub fn from_reader(reader: impl Read + Send + 'static) -> Body ⓘ

Create a body from a reader.

pub fn is_empty(&self) -> bool

Report if this body is empty.

pub fn is_seekable(&self) -> bool

Check if this body reports seeking.

pub fn len(&self) -> Option<usize>

Get the size of the body, if known.

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

Get the response body as a string.

If the body comes from a stream, the steam bytes will be consumed and this method will return an empty string next call. If this body supports seeking, you can seek to the beginning of the body if you need to call this method again later.

Trait Implementations

impl Debug for Body

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

Formats the value using the given formatter. Read more

impl Default for Body

fn default() -> Self

Returns the “default value” for a type. Read more

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

fn from(body: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Body

fn from(body: &'a str) -> Self

Converts to this type from the input type.

impl From<()> for Body

fn from(_: ()) -> Self

Converts to this type from the input type.

impl From<Bytes> for Body

fn from(body: Bytes) -> Self

Converts to this type from the input type.

impl From<File> for Body

fn from(body: File) -> Self

Converts to this type from the input type.

impl<T: Into<Body>> From<Option<T>> for Body

fn from(body: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for Body

fn from(body: String) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl Read for Body

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

1.36.0 · source

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation. Read more

1.0.0 · source

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more

1.0.0 · source

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more

1.6.0 · source

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf. Read more

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer. Read more

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor. Read more

1.0.0 · source

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

Creates a “by reference” adaptor for this instance of Read. Read more

1.0.0 · source

fn bytes(self) -> Bytes<Self>where
Self: Sized,

Transforms this Read instance to an Iterator over its bytes. Read more

1.0.0 · source

fn chain<R>(self, next: R) -> Chain<Self, R>where
R: Read,
Self: Sized,

Creates an adapter which will chain this stream with another. Read more

1.0.0 · source

fn take(self, limit: u64) -> Take<Self>where
Self: Sized,

Creates an adapter which will read at most limit bytes from it. Read more

impl Seek for Body

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream. Read more

1.55.0 · source

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream. Read more

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes). Read more

1.51.0 · source

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream. Read more

Auto Trait Implementations

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

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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<R> ReadBytesExt for Rwhere
R: Read + ?Sized,

fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more

fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more

fn read_u16<T>(&mut self) -> Result<u16, Error>where
T: ByteOrder,

Reads an unsigned 16 bit integer from the underlying reader. Read more

fn read_i16<T>(&mut self) -> Result<i16, Error>where
T: ByteOrder,

Reads a signed 16 bit integer from the underlying reader. Read more

fn read_u24<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

Reads an unsigned 24 bit integer from the underlying reader. Read more

fn read_i24<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

Reads a signed 24 bit integer from the underlying reader. Read more

fn read_u32<T>(&mut self) -> Result<u32, Error>where
T: ByteOrder,

Reads an unsigned 32 bit integer from the underlying reader. Read more

fn read_i32<T>(&mut self) -> Result<i32, Error>where
T: ByteOrder,

Reads a signed 32 bit integer from the underlying reader. Read more

fn read_u48<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned 48 bit integer from the underlying reader. Read more

fn read_i48<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed 48 bit integer from the underlying reader. Read more

fn read_u64<T>(&mut self) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned 64 bit integer from the underlying reader. Read more

fn read_i64<T>(&mut self) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed 64 bit integer from the underlying reader. Read more

fn read_u128<T>(&mut self) -> Result<u128, Error>where
T: ByteOrder,

Reads an unsigned 128 bit integer from the underlying reader. Read more

fn read_i128<T>(&mut self) -> Result<i128, Error>where
T: ByteOrder,

Reads a signed 128 bit integer from the underlying reader. Read more

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error>where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader. Read more

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error>where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader. Read more

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error>where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader.

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error>where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader.

fn read_f32<T>(&mut self) -> Result<f32, Error>where
T: ByteOrder,

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

fn read_f64<T>(&mut self) -> Result<f64, Error>where
T: ByteOrder,

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

Reads a sequence of signed 8 bit integers from the underlying reader. Read more

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of signed 128 bit integers from the underlying reader. Read more

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error>where
T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f32_into instead

DEPRECATED. Read more

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error>where
T: ByteOrder,

👎Deprecated since 1.2.0: please use read_f64_into instead

DEPRECATED. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Erased for T