[−][src]Struct isahc::AsyncBody
Contains the body of an asynchronous 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. An AsyncBody
can be created
from many types of sources using the Into
trait or
one of its constructor functions.
For asynchronous requests, you must use an asynchronous body, because the
entire request lifecycle is also asynchronous. You can create a body from
anything that implements [AsyncRead
], which AsyncBody
itself also
implements.
For synchronous requests, use Body
instead.
Implementations
impl AsyncBody
[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_static<B>(bytes: B) -> Self where
B: AsRef<[u8]> + 'static,
[src]
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>(read: R) -> Self where
R: AsyncRead + Send + Sync + 'static,
[src]
R: AsyncRead + 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>(read: R, length: u64) -> Self where
R: AsyncRead + Send + Sync + 'static,
[src]
R: AsyncRead + 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
[src]
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>
[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 AsyncBody
[src]
pub fn poll_read(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8]
) -> Poll<Result<usize>>
[src]
mut 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>>
self: Pin<&mut Self>,
cx: &mut Context<'_>,
bufs: &mut [IoSliceMut<'_>]
) -> Poll<Result<usize, Error>>
impl Debug for AsyncBody
[src]
impl Default for AsyncBody
[src]
impl From<&'_ [u8]> for AsyncBody
[src]
impl From<&'_ str> for AsyncBody
[src]
impl From<()> for AsyncBody
[src]
impl<T: Into<Self>> From<Option<T>> for AsyncBody
[src]
impl From<String> for AsyncBody
[src]
impl From<Vec<u8, Global>> for AsyncBody
[src]
Auto Trait Implementations
impl !RefUnwindSafe for AsyncBody
[src]
impl Send for AsyncBody
[src]
impl Sync for AsyncBody
[src]
impl Unpin for AsyncBody
[src]
impl !UnwindSafe for AsyncBody
[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>,