Struct isahc::Body [−][src]
pub struct Body(_);
Expand description
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
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.
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");
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.
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.
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.
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”.
Trait Implementations
Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more
Like read
, except that it reads into a slice of buffers. Read more
can_vector
)Determines if this Read
er has an efficient read_vectored
implementation. Read more
read_initializer
)Determines if this Read
er can work with buffers of uninitialized
memory. Read more
Read all bytes until EOF in this source, placing them into buf
. Read more
Read all bytes until EOF in this source, appending them to buf
. Read more
Read the exact number of bytes required to fill buf
. Read more
Creates a “by reference” adapter for this instance of Read
. Read more
Creates an adapter which will chain this stream with another. Read more
Auto Trait Implementations
impl !RefUnwindSafe for Body
impl !UnwindSafe for Body
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more