Struct isahc::Body [−][src]
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 are stored. A Body can be created from many
types of sources using the Into trait or one of its
constructor functions.
Since the entire request life-cycle in Isahc is asynchronous, bodies must
also be asynchronous. You can create a body from anything that implements
AsyncRead, which Body itself also implements.
Implementations
impl Body[src]
pub const fn empty() -> Self[src]
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(bytes: impl AsRef<[u8]>) -> Self[src]
Create a new body from bytes stored in memory.
The body will have a known length equal to the number of bytes given.
Examples
use isahc::Body; // Create a body from a string. let body = Body::from_bytes("hello world");
pub fn from_maybe_shared(bytes: impl AsRef<[u8]> + 'static) -> Self[src]
Attempt to create a new body from a shared Bytes buffer.
This will try to prevent a copy if the type passed is the type used internally, and will copy the data if it is not.
pub fn from_reader(read: impl AsyncRead + Send + Sync + 'static) -> Self[src]
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(
read: impl AsyncRead + Send + Sync + 'static,
length: u64
) -> Self[src]
read: impl AsyncRead + Send + Sync + 'static,
length: u64
) -> Self
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[src]
Report if this body is empty.
pub fn len(&self) -> Option<u64>[src]
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[src]
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 AsyncRead for Body[src]
fn poll_read(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
pub fn poll_read_vectored(
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>
impl Debug for Body[src]
impl Default for Body[src]
impl From<&'static [u8]> for Body[src]
fn from(body: &'static [u8]) -> Self[src]
impl From<&'static str> for Body[src]
impl From<()> for Body[src]
impl<T: Into<Body>> From<Option<T>> for Body[src]
impl From<String> for Body[src]
impl From<Vec<u8, Global>> for Body[src]
impl Read for Body[src]
fn read(&mut self, buf: &mut [u8]) -> Result<usize>[src]
pub fn read_vectored(
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>1.36.0[src]
&mut self,
bufs: &mut [IoSliceMut<'_>]
) -> Result<usize, Error>
pub fn is_read_vectored(&self) -> bool[src]
pub unsafe fn initializer(&self) -> Initializer[src]
pub fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>1.0.0[src]
pub fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>1.0.0[src]
pub fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>1.6.0[src]
pub fn by_ref(&mut self) -> &mut Self1.0.0[src]
pub fn bytes(self) -> Bytes<Self>1.0.0[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read, 1.0.0[src]
R: Read,
pub fn take(self, limit: u64) -> Take<Self>1.0.0[src]
Auto Trait Implementations
impl !RefUnwindSafe for Body[src]
impl Send for Body[src]
impl Sync for Body[src]
impl Unpin for Body[src]
impl !UnwindSafe for Body[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<R> AsyncReadExt for R where
R: AsyncRead + ?Sized, [src]
R: AsyncRead + ?Sized,
pub fn read(&'a mut self, buf: &'a mut [u8]) -> ReadFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn read_vectored(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>]
) -> ReadVectoredFuture<'a, Self> where
Self: Unpin,
pub fn read_to_end(
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
buf: &'a mut Vec<u8, Global>
) -> ReadToEndFuture<'a, Self> where
Self: Unpin,
pub fn read_to_string(
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin, [src]
&'a mut self,
buf: &'a mut String
) -> ReadToStringFuture<'a, Self> where
Self: Unpin,
pub fn read_exact(&'a mut self, buf: &'a mut [u8]) -> ReadExactFuture<'a, Self> where
Self: Unpin, [src]
Self: Unpin,
pub fn take(self, limit: u64) -> Take<Self>[src]
pub fn bytes(self) -> Bytes<Self>[src]
pub fn chain<R>(self, next: R) -> Chain<Self, R> where
R: AsyncRead, [src]
R: AsyncRead,
pub fn boxed_reader<'a>(self) -> Pin<Box<dyn AsyncRead + 'a + Send, Global>> where
Self: Send + 'a, [src]
Self: Send + 'a,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T> Instrument for T[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>[src]
pub fn in_current_span(self) -> Instrumented<Self>[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> WithSubscriber for T[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>, [src]
S: Into<Dispatch>,