rust-h11 0.1.0

A pure-Rust, bring-your-own-I/O implementation of HTTP/1.1
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! Sans-I/O HTTP/1.1 protocol handling.
//!
//! This crate parses and serializes HTTP/1.1 events without owning sockets,
//! timers, or tasks. Applications feed bytes into a [`Connection`] with
//! [`Connection::receive_data`], pull protocol events with
//! [`Connection::next_event`], and serialize outbound events with
//! [`Connection::send`].
//!
//! The API follows the same model as Python h11: callers drive a state machine
//! by exchanging typed events such as [`Request`], [`Response`], [`Data`], and
//! [`EndOfMessage`]. Invalid local usage returns [`LocalProtocolError`], while
//! malformed peer input returns [`RemoteProtocolError`].
//!
//! Use the fallible constructors such as [`Request::new_http11`],
//! [`Response::new_final_http11`], and [`Headers::new`] for public inputs.
//! Struct fields are currently public for compatibility, but manually-built
//! values should be validated before being sent.

#![allow(
    clippy::byte_char_slices,
    clippy::collapsible_if,
    clippy::for_kv_map,
    clippy::len_zero,
    clippy::match_like_matches_macro,
    clippy::needless_return,
    clippy::ptr_arg,
    clippy::redundant_pattern_matching,
    clippy::type_complexity,
    clippy::unit_arg,
    clippy::unnecessary_mut_passed,
    clippy::unnecessary_to_owned,
    clippy::unnecessary_unwrap,
    clippy::useless_conversion,
    clippy::useless_vec,
    clippy::while_let_loop,
    clippy::while_let_on_iterator
)]
mod _abnf;
mod _connection;
mod _events;
mod _headers;
mod _readers;
mod _receivebuffer;
mod _state;
mod _util;
mod _writers;

pub use _connection::Connection;
pub use _events::{ConnectionClosed, Data, EndOfMessage, Event, Request, Response};
pub use _headers::Headers;
pub use _state::{EventType, Role, State, Switch};
pub use _util::{LocalProtocolError, ProtocolError, RemoteProtocolError};

/// Product token for identifying this protocol implementation.
///
/// This is intended for callers that want a default `User-Agent` or `Server`
/// header value. The crate never injects it automatically.
pub const PRODUCT_ID: &str = concat!("rust-h11/", env!("CARGO_PKG_VERSION"));

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn product_id_tracks_crate_version() {
        assert_eq!(
            PRODUCT_ID,
            format!("rust-h11/{}", env!("CARGO_PKG_VERSION"))
        );
    }
}