c122e97127
This patch does a bunch of refactoring, mostly around error types, but it also
paves the way to allow `Codec` to be used standalone.
* `Codec` (and `FramedRead` / `FramedWrite`) is broken out into a codec module.
* An h2-codec crate is created that re-exports the frame and codec modules.
* New error types are introduced in the internals:
* `RecvError` represents errors caused by trying to receive a frame.
* `SendError` represents errors caused by trying to send a frame.
* `UserError` is an enum of potential errors caused by invalid usage
by the user of the lib.
* `ProtoError` is either a `Reason` or an `io::Error`. However it doesn't
specify connection or stream level.
* `h2::Error` is an opaque error type and is the only error type exposed
by the public API (used to be `ConnectionError`).
There are misc code changes to enable this as well. The biggest is a new "sink"
API for `Codec`. It provides buffer which queues up a frame followed by flush
which writes everything that is queued. This departs from the `Sink` trait in
order to provide more accurate error values. For example, buffer can never fail
(but it will panic if `poll_ready` is not called first).
H2
A Tokio aware, HTTP/2.0 client & server implementation for Rust.
This library is not production ready. Do not try to use it in a production environment or you will regret it! This crate is still under active development and there has not yet been any focus on documentation (because you shouldn't be using it yet!).
More information about this crate can be found in the crate documentation
Features
- Client and server HTTP/2.0 implementation.
- Implements the full HTTP/2.0 specification (soon).
- Passes h2spec (soon).
- Focus on performance and correctness.
- Built on Tokio.
Non goals
This crate is intended to only be an implementation of the HTTP/2.0 specification. It does not handle:
- Managing TCP connections
- HTTP 1.0 ugprade
- TLS
- Any feature not described by the HTTP/2.0 specification.
The intent is that this crate will eventually be used by hyper, which will provide all of these features.
Usage
To use h2, first add this to your Cargo.toml:
[dependencies]
h2 = { git = 'https://github.com/carllerche/h2' } # soon to be on crates.io!
Next, add this to your crate:
extern crate h2;
use h2::server::Server;
fn main() {
// ...
}
License
h2 is primarily distributed under the terms of both the MIT license and the
Apache License (Version 2.0), with portions covered by various BSD-like
licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.