Skip to main content

Body

go_http::parse::transfer

Enum Body

pub enum Body {
    Limited(Take<Box<dyn Read + Send>>),
    Chunked(ChunkedReader<Box<dyn Read + Send>>),
    Unbounded(Box<dyn Read + Send>),
    Empty,
    Capped {
        inner: Box<Body>,
        remaining: u64,
    },
}

Expand description

An HTTP message body.

Variants§

Limited(Take<Box<dyn Read + Send>>)

Body of exactly n bytes.

Chunked(ChunkedReader<Box<dyn Read + Send>>)

Chunked transfer-encoded body.

Unbounded(Box<dyn Read + Send>)

Body read until connection close (response only).

Empty

No body (HEAD, 204, 304, …).

Capped

Any body wrapped with a hard byte cap; returns an error on overflow.

Fields

§inner: Box<Body>

§remaining: u64

Implementations§

impl Body

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

Read the entire body into a Vec<u8>.

Used by the HTTP client to buffer the response body before releasing the underlying TcpStream back to the connection pool. Buffering first ensures the stream is fully drained and that no try_clone() alias of the stream is live when the next request starts, which would cause concurrent reads on the same socket and SIGSEGV on Linux/epoll.

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

Wrap this body with a hard byte cap. Reads beyond limit bytes return an io::Error rather than silently truncating.

pub fn trailers(&self) -> &Header

Return trailer headers if this is a chunked body that has been fully read. Returns an empty header for all other body types.

pub fn into_trailers(self) -> Header

Consume the body and return any trailer headers (chunked bodies only).

Trait Implementations§

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>) -> Result<usize, Error>

Reads 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>

Reads 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>

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

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> 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<'_, u8>, ) -> Result<(), Error>

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

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

1.0.0 · Source§

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

Creates a “by reference” adapter 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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>
where Self: Sized,

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

Read and return a fixed array of bytes from this source. Read more

fn read_le<T>(&mut self) -> Result<T, Error>
where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order. Read more

fn read_be<T>(&mut self) -> Result<T, Error>
where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for Body

impl !Sync for Body

impl !UnwindSafe for Body

impl Freeze for Body

impl Send for Body

impl Unpin for Body

impl UnsafeUnpin for Body

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.