Expand description
§hyper
hyper is a fast and correct HTTP implementation written in and for Rust.
§Features
- HTTP/1 and HTTP/2
- Asynchronous design
- Leading in performance
- Tested and correct
- Extensive production use
- Client and Server APIs
If just starting out, check out the Guides first.
§“Low-level”
hyper is a lower-level HTTP library, meant to be a building block for libraries and applications.
If looking for just a convenient HTTP client, consider the reqwest crate.
§Optional Features
hyper uses a set of feature flags to reduce the amount of compiled code. It is possible to just enable certain features over others. By default, hyper does not enable any features but allows one to enable a subset for their use case. Below is a list of the available feature flags. You may also notice above each function, struct and trait there is listed one or more feature flags that are required for that item to be used.
If you are new to hyper it is possible to enable the full
feature flag
which will enable all public APIs. Beware though that this will pull in
many extra dependencies that you may not need.
The following optional features are available:
http1
: Enables HTTP/1 support.http2
: Enables HTTP/2 support.client
: Enables the HTTPclient
.server
: Enables the HTTPserver
.runtime
: Enables convenient integration withtokio
, providing connectors and acceptors for TCP, and a default executor.tcp
: Enables convenient implementations over TCP (using tokio).stream
: Providesfutures::Stream
capabilities.backports
: 1.0 functionality backported to 0.14.deprecated
: opt-in to deprecation warnings to prepare you for 1.0.
Re-exports§
pub use crate::http::HeaderMap;
pub use crate::body::Body;
pub use crate::client::Client;
pub use crate::server::Server;
Modules§
- Streaming bodies for Requests and Responses
- cfg 🔒
- HTTP Client
- common 🔒
- error 🔒Error and Result module.
- HTTP extensions.
- HTTP header types
- headers 🔒
- proto 🔒Pieces pertaining to the HTTP message protocol.
- Runtime components
- HTTP Server
- Asynchronous Services
- HTTP Upgrades
Structs§
- Represents errors that can occur handling HTTP streams.
- The Request Method (VERB)
- Represents an HTTP request.
- Represents an HTTP response
- An HTTP status code (
status-code
in RFC 7230 et al.). - The URI component of a request.
- Represents a version of the HTTP spec.
Type Aliases§
- Result type often returned from methods that can have hyper
Error
s.