pub struct Body { /* private fields */ }
Expand description
An HTTP body that can be read from, written to, or appended to another body.
The most efficient ways to read from and write to the body are through the Read
,
BufRead
, and Write
implementations.
Read and write operations to a Body
are automatically buffered, though you can take direct
control over aspects of the buffering using the BufRead
methods and Write::flush()
.
Implementations§
Source§impl Body
impl Body
Sourcepub fn into_handle(self) -> BodyHandle ⓘ
pub fn into_handle(self) -> BodyHandle ⓘ
Convert a Body
into the low-level BodyHandle
interface.
Sourcepub fn into_bytes(self) -> Vec<u8> ⓘ
pub fn into_bytes(self) -> Vec<u8> ⓘ
Read the entirety of the body into a byte vector.
§Memory usage
This method will cause the entire body to be buffering in WebAssembly memory. You should take care
not to exceed the WebAssembly memory limits, and consider using methods like BufRead::lines()
or
Body::read_chunks()
to control how much of the body you process at once.
Sourcepub fn into_string(self) -> String
pub fn into_string(self) -> String
Read the entirety of the body into a String
, interpreting the bytes as UTF-8.
§Memory usage
This method will cause the entire body to be buffering in WebAssembly memory. You should take care
not to exceed the WebAssembly memory limits, and consider using methods like BufRead::lines()
or
Body::read_chunks()
to control how much of the body you process at once.
§Panics
If the body does not contain a valid UTF-8 string, this function will panic. To explicitly handle
the possibility of invalid UTF-8 data, use into_bytes()
and then convert
the bytes explicitly with a function like String::from_utf8
.
Sourcepub fn append(&mut self, other: Body)
pub fn append(&mut self, other: Body)
Append another body onto the end of this body.
This operation is performed in amortized constant time, and so should always be preferred to reading an entire body and then writing the same contents to another body.
Sourcepub fn write_bytes(&mut self, bytes: &[u8]) -> usize
👎Deprecated since 0.10.0: use std::io::Write::write() instead
pub fn write_bytes(&mut self, bytes: &[u8]) -> usize
Write a slice of bytes to the end of this body, and return the number of bytes written.
§Examples
body.write_bytes(&[0, 1, 2, 3]);
Sourcepub fn write_str(&mut self, string: &str) -> usize
👎Deprecated since 0.10.0: use std::io::Write::write() instead
pub fn write_str(&mut self, string: &str) -> usize
Write a string slice to the end of this body, and return the number of bytes written.
§Examples
body.write_str("woof woof");
Sourcepub fn read_chunks<'a>(
&'a mut self,
chunk_size: usize,
) -> impl Iterator<Item = Result<Vec<u8>, Error>> + 'a
pub fn read_chunks<'a>( &'a mut self, chunk_size: usize, ) -> impl Iterator<Item = Result<Vec<u8>, Error>> + 'a
Return an iterator that reads the body in chunks of at most the given number of bytes.
If chunk_size
does not evenly divide the length of the body, then the last chunk will not
have length chunk_size
.
§Examples
use std::io::Write;
fn remove_0s(body: &mut Body) {
let mut no_0s = Body::new();
for chunk in body.read_chunks(4096) {
let mut chunk = chunk.unwrap();
chunk.retain(|b| *b != 0);
no_0s.write_all(&chunk).unwrap();
}
*body = no_0s;
}
Sourcepub fn get_prefix_mut(&mut self, length: usize) -> Prefix<'_>
pub fn get_prefix_mut(&mut self, length: usize) -> Prefix<'_>
Get a prefix of the body containing up to the given number of bytes.
This is particularly useful when you only need to inspect the first few bytes of a body, or want to read an entire body up to a certain size limit to control memory consumption.
Note that the length of the returned prefix may be shorter than the requested length if the length of the entire body is shorter.
The returned Prefix
value is a smart pointer wrapping a &mut Vec<u8>
. You can use it
as you would a &mut Vec<u8>
or a &mut [u8]
to view or modify
the contents of the prefix.
When the Prefix
is dropped, the prefix bytes are returned to the body, including any
modifications that have been made. Because the prefix holds a mutable reference to the body,
you may need to explicitly drop()
the prefix to perform other operations on the
body.
If you do not need to return the prefix bytes to the body, use Prefix::take()
to consume
the prefix as an owned byte vector without writing it back.
§Examples
Checking whether the body starts with the WebAssembly magic number:
const MAGIC: &[u8] = b"\0asm";
let prefix = body.get_prefix_mut(MAGIC.len());
if prefix.as_slice() == MAGIC {
println!("might be Wasm!");
}
Zero out the timestamp bytes in a gzip header:
let mut prefix = body.get_prefix_mut(8);
for i in 4..8 {
prefix[i] = 0;
}
Try to consume the body as a JSON value, but only up to the first
4KiB. Note the use of take()
to avoid writing the bytes back to the body unnecessarily:
let prefix = body.get_prefix_mut(4096).take();
let json: serde_json::Value = serde_json::from_slice(&prefix).unwrap();
Sourcepub fn try_get_prefix_mut(&mut self, length: usize) -> Result<Prefix<'_>>
pub fn try_get_prefix_mut(&mut self, length: usize) -> Result<Prefix<'_>>
Try to get a prefix of the body up to the given number of bytes.
Unlike get_prefix_mut()
, this method does not panic if an I/O
error occurs.
Sourcepub fn get_prefix_str_mut(&mut self, length: usize) -> PrefixString<'_>
pub fn get_prefix_str_mut(&mut self, length: usize) -> PrefixString<'_>
Get a prefix of the body as a string containing up to the given number of bytes.
This is particularly useful when you only need to inspect the first few characters of a body or want to read an entire body up to a certain size limit to control memory consumption.
Note that the length of the returned prefix may be shorter than the requested length if the length of the entire body is shorter or if the requested length fell in the middle of a multi-byte UTF-8 codepoint.
The returned PrefixString
value is a smart pointer wrapping a &mut String
. You can use
it as you would a &mut String
or a &mut str
to view or modify
the contents of the prefix.
When the PrefixString
is dropped, the prefix characters are returned to the body,
including any modifications that have been made. Because the prefix holds a mutable
reference to the body, you may need to explicitly drop()
the prefix before performing
other operations on the body.
If you do not need to return the prefix characters to the body, use PrefixString::take()
to
consume the prefix as an owned string without writing it back.
§Panics
If the prefix contains invalid UTF-8 bytes, this function will panic. The exception to this is if the bytes are invalid because a multi-byte codepoint is cut off by the requested prefix length. In this case, the invalid bytes are left off the end of the prefix.
To explicitly handle the possibility of invalid UTF-8 bytes, use
try_get_prefix_str_mut()
, which returns an error on
failure rather than panicking.
§Examples
Check whether the body starts with the M3U8 file header:
const HEADER: &str = "#EXTM3U";
let prefix = body.get_prefix_str_mut(7);
if prefix.as_str() == HEADER {
println!("might be an M3U8 file!");
}
Insert a new playlist entry before the first occurrence of #EXTINF
in an M3U8
file:
let mut prefix = body.get_prefix_str_mut(1024);
let first_entry = prefix.find("#EXTINF").unwrap();
prefix.insert_str(first_entry, "#EXTINF:10.0,\nnew_first_file.ts\n");
Try to consume the body as a JSON value, but only up to the first
4KiB. Note the use of take()
to avoid writing the characters back to the body unnecessarily:
let prefix = body.get_prefix_str_mut(4096).take();
let json: serde_json::Value = serde_json::from_str(&prefix).unwrap();
Sourcepub fn try_get_prefix_str_mut(
&mut self,
length: usize,
) -> Result<PrefixString<'_>, Utf8Error>
pub fn try_get_prefix_str_mut( &mut self, length: usize, ) -> Result<PrefixString<'_>, Utf8Error>
Try to get a prefix of the body as a string containing up to the given number of bytes.
Unlike get_prefix_str_mut()
, this function does not panic
when the prefix contains invalid UTF-8 bytes.
Trait Implementations§
Source§impl BodyExt for Body
impl BodyExt for Body
Source§fn append_trailer(&mut self, name: impl ToHeaderName, value: impl ToHeaderValue)
fn append_trailer(&mut self, name: impl ToHeaderName, value: impl ToHeaderValue)
Source§impl BufRead for Body
impl BufRead for Body
Source§fn fill_buf(&mut self) -> Result<&[u8]>
fn fill_buf(&mut self) -> Result<&[u8]>
Read
methods, if empty. Read moreSource§fn consume(&mut self, amt: usize)
fn consume(&mut self, amt: usize)
amount
of additional bytes from the internal buffer as having been read.
Subsequent calls to read
only return bytes that have not been marked as read. Read moreSource§fn has_data_left(&mut self) -> Result<bool, Error>
fn has_data_left(&mut self) -> Result<bool, Error>
buf_read_has_data_left
)read
. Read more1.83.0 · Source§fn skip_until(&mut self, byte: u8) -> Result<usize, Error>
fn skip_until(&mut self, byte: u8) -> Result<usize, Error>
byte
or EOF is reached. Read more1.0.0 · Source§fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>
0xA
byte) is reached, and append
them to the provided String
buffer. Read moreSource§impl From<BodyHandle> for Body
impl From<BodyHandle> for Body
Source§fn from(handle: BodyHandle) -> Self
fn from(handle: BodyHandle) -> Self
Source§impl Read for Body
impl Read for Body
Source§fn read(&mut self, buf: &mut [u8]) -> Result<usize>
fn read(&mut self, buf: &mut [u8]) -> Result<usize>
Source§fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>
read
, except that it reads into a slice of buffers. Read moreSource§fn is_read_vectored(&self) -> bool
fn is_read_vectored(&self) -> bool
can_vector
)1.0.0 · Source§fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>
buf
. Read more1.0.0 · Source§fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>
buf
. Read more1.6.0 · Source§fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>
buf
. Read moreSource§fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)Source§fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>
read_buf
)cursor
. Read more1.0.0 · Source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
Read
. Read moreSource§impl Write for Body
impl Write for Body
Source§fn write(&mut self, buf: &[u8]) -> Result<usize>
fn write(&mut self, buf: &[u8]) -> Result<usize>
Source§fn flush(&mut self) -> Result<()>
fn flush(&mut self) -> Result<()>
Source§fn is_write_vectored(&self) -> bool
fn is_write_vectored(&self) -> bool
can_vector
)1.0.0 · Source§fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>
Source§fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>
write_all_vectored
)Auto Trait Implementations§
impl Freeze for Body
impl RefUnwindSafe for Body
impl Send for Body
impl Sync for Body
impl Unpin for Body
impl UnwindSafe for Body
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more