Crate body_image[−][src]
This crate provides a few separately usable but closely related HTTP ecosystem components.
In the root module, the BodyImage
struct
and supporting types provides a strategy for safely handling
potentially large HTTP request or response bodies without risk of
allocation failure, or the need to impose awkwardly low size limits in the
face of high concurrency. Tunables
size thresholds can be used to decide
when to accumulate the body in RAM vs the filesystem, including when the
length is unknown in advance.
See the top level README for additional rationale.
A Dialog
defines a complete HTTP request and
response recording, using BodyImage
for the request and response bodies
and http crate types for the headers and other components.
The barc module defines a container file format, reader and writer for dialog records. This has broad use cases, from convenient test fixtures for web applications, to caching and web crawling.
Optional Features
The following features may be enabled or disabled at build time:
client (non-default): The client module for
recording of HTTP Dialog
s via hyper 0.12.x and tokio.
cli (default): The barc
command line tool for viewing
(e.g. compressed) records and copying records across BARC files. If the
client feature is enabled, than a record
command is also provided for
live BARC recording from the network.
brotli (default): Brotli transfer/content decoding in the client, and Brotli BARC record compression, via the native-rust brotli crate. (Gzip, via the flate2 crate, is standard.)
mmap (default): Adds BodyImage::mem_map
support for memory mapping
from FsRead
state.
For complete functionally, build or install with --all-features
.
Modules
barc |
Body Archive container file format, reader and writer. |
client |
HTTP client integration and utilities. |
Structs
BodyImage |
A logical buffer of bytes, which may or may not be RAM resident. |
BodySink |
A logical buffer of bytes, which may or may not be RAM resident, in the
process of being written. This is the write-side corollary to
|
Dialog |
An HTTP request and response recording. |
Tunables |
A collection of size limits and performance tuning constants. Setters are
available via |
Tuner |
A builder for |
Enums
BodyError |
Error enumeration for |
BodyReader |
Provides a |
Encoding |
A subset of supported HTTP Transfer or Content-Encoding values. The
|
Statics
VERSION |
The crate version string. |
Traits
Recorded |
Access by reference for HTTP request (via |
RequestRecorded |
Access by reference for HTTP request recording types. |