| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/h2-0.3.19/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../h2/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../h2/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! An asynchronous, HTTP/2 server and client implementation. |
| //! |
| //! This library implements the [HTTP/2] specification. The implementation is |
| //! asynchronous, using [futures] as the basis for the API. The implementation |
| //! is also decoupled from TCP or TLS details. The user must handle ALPN and |
| //! HTTP/1.1 upgrades themselves. |
| //! |
| //! # Getting started |
| //! |
| //! Add the following to your `Cargo.toml` file: |
| //! |
| //! ```toml |
| //! [dependencies] |
| //! h2 = "0.3" |
| //! ``` |
| //! |
| //! # Layout |
| //! |
| //! The crate is split into [`client`] and [`server`] modules. Types that are |
| //! common to both clients and servers are located at the root of the crate. |
| //! |
| //! See module level documentation for more details on how to use `h2`. |
| //! |
| //! # Handshake |
| //! |
| //! Both the client and the server require a connection to already be in a state |
| //! ready to start the HTTP/2 handshake. This library does not provide |
| //! facilities to do this. |
| //! |
| //! There are three ways to reach an appropriate state to start the HTTP/2 |
| //! handshake. |
| //! |
| //! * Opening an HTTP/1.1 connection and performing an [upgrade]. |
| //! * Opening a connection with TLS and use ALPN to negotiate the protocol. |
| //! * Open a connection with prior knowledge, i.e. both the client and the |
| //! server assume that the connection is immediately ready to start the |
| //! HTTP/2 handshake once opened. |
| //! |
| //! Once the connection is ready to start the HTTP/2 handshake, it can be |
| //! passed to [`server::handshake`] or [`client::handshake`]. At this point, the |
| //! library will start the handshake process, which consists of: |
| //! |
| //! * The client sends the connection preface (a predefined sequence of 24 |
| //! octets). |
| //! * Both the client and the server sending a SETTINGS frame. |
| //! |
| //! See the [Starting HTTP/2] in the specification for more details. |
| //! |
| //! # Flow control |
| //! |
| //! [Flow control] is a fundamental feature of HTTP/2. The `h2` library |
| //! exposes flow control to the user. |
| //! |
| //! An HTTP/2 client or server may not send unlimited data to the peer. When a |
| //! stream is initiated, both the client and the server are provided with an |
| //! initial window size for that stream. A window size is the number of bytes |
| //! the endpoint can send to the peer. At any point in time, the peer may |
| //! increase this window size by sending a `WINDOW_UPDATE` frame. Once a client |
| //! or server has sent data filling the window for a stream, no further data may |
| //! be sent on that stream until the peer increases the window. |
| //! |
| //! There is also a **connection level** window governing data sent across all |
| //! streams. |
| //! |
| //! Managing flow control for inbound data is done through [`FlowControl`]. |
| //! Managing flow control for outbound data is done through [`SendStream`]. See |
| //! the struct level documentation for those two types for more details. |
| //! |
| //! [HTTP/2]: https://http2.github.io/ |
| //! [futures]: https://docs.rs/futures/ |
| //! [`client`]: client/index.html |
| //! [`server`]: server/index.html |
| //! [Flow control]: http://httpwg.org/specs/rfc7540.html#FlowControl |
| //! [`FlowControl`]: struct.FlowControl.html |
| //! [`SendStream`]: struct.SendStream.html |
| //! [Starting HTTP/2]: http://httpwg.org/specs/rfc7540.html#starting |
| //! [upgrade]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Protocol_upgrade_mechanism |
| //! [`server::handshake`]: server/fn.handshake.html |
| //! [`client::handshake`]: client/fn.handshake.html |
| |
| </span><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/h2/0.3.19"</span>)] |
| #![deny(missing_debug_implementations, missing_docs)] |
| #![cfg_attr(test, deny(warnings))] |
| #![allow(clippy::type_complexity, clippy::manual_range_contains)] |
| |
| </span><span class="macro">macro_rules! </span>proto_err { |
| (conn: $(<span class="macro-nonterminal">$msg</span>:tt)+) => { |
| <span class="macro">tracing::debug!</span>(<span class="string">"connection error PROTOCOL_ERROR -- {};"</span>, <span class="macro">format_args!</span>($(<span class="macro-nonterminal">$msg</span>)+)) |
| }; |
| (stream: $(<span class="macro-nonterminal">$msg</span>:tt)+) => { |
| <span class="macro">tracing::debug!</span>(<span class="string">"stream error PROTOCOL_ERROR -- {};"</span>, <span class="macro">format_args!</span>($(<span class="macro-nonterminal">$msg</span>)+)) |
| }; |
| } |
| |
| <span class="macro">macro_rules! </span>ready { |
| (<span class="macro-nonterminal">$e</span>:expr) => { |
| <span class="kw">match </span><span class="macro-nonterminal">$e </span>{ |
| ::std::task::Poll::Ready(r) => r, |
| ::std::task::Poll::Pending => <span class="kw">return </span>::std::task::Poll::Pending, |
| } |
| }; |
| } |
| |
| <span class="attribute">#[cfg_attr(feature = <span class="string">"unstable"</span>, allow(missing_docs))] |
| </span><span class="kw">mod </span>codec; |
| <span class="kw">mod </span>error; |
| <span class="kw">mod </span>hpack; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"unstable"</span>))] |
| </span><span class="kw">mod </span>proto; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| #[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>proto; |
| |
| <span class="attribute">#[cfg(not(feature = <span class="string">"unstable"</span>))] |
| </span><span class="kw">mod </span>frame; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| #[allow(missing_docs)] |
| </span><span class="kw">pub mod </span>frame; |
| |
| <span class="kw">pub mod </span>client; |
| <span class="kw">pub mod </span>ext; |
| <span class="kw">pub mod </span>server; |
| <span class="kw">mod </span>share; |
| |
| <span class="attribute">#[cfg(fuzzing)] |
| #[cfg_attr(feature = <span class="string">"unstable"</span>, allow(missing_docs))] |
| </span><span class="kw">pub mod </span>fuzz_bridge; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::error::{Error, Reason}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::share::{FlowControl, Ping, PingPong, Pong, RecvStream, SendStream, StreamId}; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"unstable"</span>)] |
| </span><span class="kw">pub use </span>codec::{Codec, SendError, UserError}; |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="h2" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
