http-type 22.0.9

A comprehensive Rust type library for HTTP operations and concurrent programming. Provides core HTTP types (Request/Response with builder patterns, Method, HttpStatus, HttpVersion, ContentType, FileExtension with MIME mapping, Cookie parsing/building, HttpUrl parsing, WebSocket frame/opcode, protocol upgrade types, stream/task management, panic handling), thread-safe concurrent wrappers (ArcMutex, ArcRwLock, BoxRwLock, RcRwLock), dynamic dispatch types (BoxAny, RcAny, ArcAny with Send/Sync variants), high-performance hash collections (HashMapXxHash3_64, HashSetXxHash3_64), and static lifetime utilities (BoxLeak, Lifetime trait).
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111

use super::*;

#[derive(CustomDebug, Data, DisplayDebug)]
pub struct Stream {
    /// The bidirectional byte pipe the request/response cycle runs over.
    ///
    /// The concrete type is erased behind `Transport`, so a plain TCP socket, a
    /// TLS session and a per-request duplex stream are interchangeable here.
    /// Address metadata comes from the transport itself, so a transport without
    /// a socket identity reports an error instead of a fabricated address.
    pub stream: Box<dyn Transport>,
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) request_config: RequestConfig,
    #[get(type(copy))]
    #[get_mut(pub(super))]
    pub(super) closed: bool,
    /// Bytes read ahead of the current request, already consumed from the
    /// transport but not yet parsed into a request.
    ///
    /// A single read can deliver bytes belonging to the next pipelined
    /// request. Those bytes are carried here between requests so
    /// HTTP pipelining is not silently dropped.
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) leftover: Vec<u8>,
    /// Offset of the first unconsumed byte in `leftover`.
    #[get(type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) leftover_start: usize,
    /// Offset one past the last valid byte in `leftover`.
    #[get(type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) leftover_end: usize,
    /// The buffer the request line is read into.
    ///
    /// It lives with the connection rather than with the request, so a
    /// keep-alive connection reads its second, third and later request lines
    /// into the same allocation instead of a fresh one per request.
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) line_buffer: String,
    /// The buffer the header lines are read into, kept for the same reason as
    /// the request line buffer.
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) header_line_buffer: String,
    /// Lazily allocated WebSocket parsing state retained across cancelled reads.
    #[get(pub(super), type(ref))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) websocket_state: Option<Box<WebSocketReadState>>,
}

/// Partial WebSocket input that must survive selection of an outbound message.
#[derive(Clone, Data, Debug, Default)]
pub(super) struct WebSocketReadState {
    /// Wire bytes not yet consumed by a complete frame.
    #[get(pub(super), type(ref))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) buffer: Vec<u8>,
    /// Payload accumulated from a message spanning multiple frames.
    #[get(pub(super))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) full_frame: Vec<u8>,
    /// Whether a peer response has arrived since the last heartbeat.
    #[get(pub(super), type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) is_client_response: bool,
}

/// A buffered reader over a transport with a reusable read buffer.
///
/// This reader batches reads into an internal buffer to reduce syscall count,
/// and returns drained buffers to a thread-local pool while waiting for more
/// input so idle keep-alive connections do not each retain a read buffer.
#[derive(Data, New)]
pub(crate) struct PooledReader<'a> {
    /// The underlying transport being read.
    #[get(pub(super))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) stream: &'a mut Box<dyn Transport>,
    /// The reusable read buffer holding unconsumed bytes in `start..end`.
    #[get(pub(super))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) buffer: Vec<u8>,
    /// The required buffer length when the transport becomes readable.
    #[get(pub(super), type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    pub(super) capacity: usize,
    /// The index of the first unconsumed byte in the buffer.
    #[get(pub(super), type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    #[new(skip)]
    pub(super) start: usize,
    /// The index one past the last valid byte in the buffer.
    #[get(pub(super), type(copy))]
    #[get_mut(pub(super))]
    #[set(pub(super))]
    #[new(skip)]
    pub(super) end: usize,
}