Struct isahc::Body

pub struct Body(_);

Contains the body of a synchronous HTTP request or response.

This type is used to encapsulate the underlying stream or region of memory where the contents of the body are stored. A Body can be created from many types of sources using the Into trait or one of its constructor functions. It can also be created from anything that implements Read, which Body itself also implements.

For asynchronous requests, use AsyncBody instead.

Implementations

impl Body

pub const fn empty() -> Self

Create a new empty body.

An empty body represents the absence of a body, which is semantically different than the presence of a body of zero length.

pub fn from_bytes_static<B>(bytes: B) -> Self where
    B: AsRef<[u8]> + 'static, 

Create a new body from a potentially static byte buffer.

The body will have a known length equal to the number of bytes given.

This will try to prevent a copy if the type passed in can be re-used, otherwise the buffer will be copied first. This method guarantees to not require a copy for the following types:

• &'static [u8]
• &'static str

Examples

use isahc::Body;

// Create a body from a static string.
let body = Body::from_bytes_static("hello world");

pub fn from_reader<R>(reader: R) -> Self where
    R: Read + Send + Sync + 'static, 

Create a streaming body that reads from the given reader.

The body will have an unknown length. When used as a request body, chunked transfer encoding might be used to send the request.

pub fn from_reader_sized<R>(reader: R, length: u64) -> Self where
    R: Read + Send + Sync + 'static, 

Create a streaming body with a known length.

If the size of the body is known in advance, such as with a file, then this function can be used to create a body that can determine its Content-Length while still reading the bytes asynchronously.

Giving a value for length that doesn't actually match how much data the reader will produce may result in errors when sending the body in a request.

pub fn is_empty(&self) -> bool

Report if this body is empty.

This is not necessarily the same as checking for self.len() == Some(0). Since HTTP message bodies are optional, there is a semantic difference between the absence of a body and the presence of a zero-length body. This method will only return true for the former.

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

Get the size of the body, if known.

The value reported by this method is used to set the Content-Length for outgoing requests.

When coming from a response, this method will report the value of the Content-Length response header if present. If this method returns None then there's a good chance that the server used something like chunked transfer encoding to send the response body.

Since the length may be determined totally separately from the actual bytes, even if a value is returned it should not be relied on as always being accurate, and should be treated as a "hint".

pub fn reset(&mut self) -> bool

If this body is repeatable, reset the body stream back to the start of the content. Returns false if the body cannot be reset.

Trait Implementations

impl Debug for Body

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

Formats the value using the given formatter.

impl Default for Body

pub fn default() -> Self

Returns the "default value" for a type.

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

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

Performs the conversion.

impl From<&'_ str> for Body

pub fn from(body: &str) -> Self

Performs the conversion.

impl From<()> for Body

pub fn from(_: ()) -> Self

Performs the conversion.

impl From<File> for Body

pub fn from(file: File) -> Self

Performs the conversion.

impl From<String> for Body

pub fn from(body: String) -> Self

Performs the conversion.

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

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

Performs the conversion.

impl Read for Body

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

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

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

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

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

Read the exact number of bytes required to fill buf.

pub fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

Creates an adaptor which will read at most limit bytes from it.