| <!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/http-0.2.9/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="../../http/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="../../http/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> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| </pre><pre class="rust"><code><span class="attribute">#![doc(html_root_url = <span class="string">"https://docs.rs/http/0.2.9"</span>)] |
| |
| </span><span class="doccomment">//! A general purpose library of common HTTP types |
| //! |
| //! This crate is a general purpose library for common types found when working |
| //! with the HTTP protocol. You'll find `Request` and `Response` types for |
| //! working as either a client or a server as well as all of their components. |
| //! Notably you'll find `Uri` for what a `Request` is requesting, a `Method` |
| //! for how it's being requested, a `StatusCode` for what sort of response came |
| //! back, a `Version` for how this was communicated, and |
| //! `HeaderName`/`HeaderValue` definitions to get grouped in a `HeaderMap` to |
| //! work with request/response headers. |
| //! |
| //! You will notably *not* find an implementation of sending requests or |
| //! spinning up a server in this crate. It's intended that this crate is the |
| //! "standard library" for HTTP clients and servers without dictating any |
| //! particular implementation. Note that this crate is still early on in its |
| //! lifecycle so the support libraries that integrate with the `http` crate are |
| //! a work in progress! Stay tuned and we'll be sure to highlight crates here |
| //! in the future. |
| //! |
| //! ## Requests and Responses |
| //! |
| //! Perhaps the main two types in this crate are the `Request` and `Response` |
| //! types. A `Request` could either be constructed to get sent off as a client |
| //! or it can also be received to generate a `Response` for a server. Similarly |
| //! as a client a `Response` is what you get after sending a `Request`, whereas |
| //! on a server you'll be manufacturing a `Response` to send back to the client. |
| //! |
| //! Each type has a number of accessors for the component fields. For as a |
| //! server you might want to inspect a requests URI to dispatch it: |
| //! |
| //! ``` |
| //! use http::{Request, Response}; |
| //! |
| //! fn response(req: Request<()>) -> http::Result<Response<()>> { |
| //! match req.uri().path() { |
| //! "/" => index(req), |
| //! "/foo" => foo(req), |
| //! "/bar" => bar(req), |
| //! _ => not_found(req), |
| //! } |
| //! } |
| //! # fn index(_req: Request<()>) -> http::Result<Response<()>> { panic!() } |
| //! # fn foo(_req: Request<()>) -> http::Result<Response<()>> { panic!() } |
| //! # fn bar(_req: Request<()>) -> http::Result<Response<()>> { panic!() } |
| //! # fn not_found(_req: Request<()>) -> http::Result<Response<()>> { panic!() } |
| //! ``` |
| //! |
| //! On a `Request` you'll also find accessors like `method` to return a |
| //! `Method` and `headers` to inspect the various headers. A `Response` |
| //! has similar methods for headers, the status code, etc. |
| //! |
| //! In addition to getters, request/response types also have mutable accessors |
| //! to edit the request/response: |
| //! |
| //! ``` |
| //! use http::{HeaderValue, Response, StatusCode}; |
| //! use http::header::CONTENT_TYPE; |
| //! |
| //! fn add_server_headers<T>(response: &mut Response<T>) { |
| //! response.headers_mut() |
| //! .insert(CONTENT_TYPE, HeaderValue::from_static("text/html")); |
| //! *response.status_mut() = StatusCode::OK; |
| //! } |
| //! ``` |
| //! |
| //! And finally, one of the most important aspects of requests/responses, the |
| //! body! The `Request` and `Response` types in this crate are *generic* in |
| //! what their body is. This allows downstream libraries to use different |
| //! representations such as `Request<Vec<u8>>`, `Response<impl Read>`, |
| //! `Request<impl Stream<Item = Vec<u8>, Error = _>>`, or even |
| //! `Response<MyCustomType>` where the custom type was deserialized from JSON. |
| //! |
| //! The body representation is intentionally flexible to give downstream |
| //! libraries maximal flexibility in implementing the body as appropriate. |
| //! |
| //! ## HTTP Headers |
| //! |
| //! Another major piece of functionality in this library is HTTP header |
| //! interpretation and generation. The `HeaderName` type serves as a way to |
| //! define header *names*, or what's to the left of the colon. A `HeaderValue` |
| //! conversely is the header *value*, or what's to the right of a colon. |
| //! |
| //! For example, if you have an HTTP request that looks like: |
| //! |
| //! ```http |
| //! GET /foo HTTP/1.1 |
| //! Accept: text/html |
| //! ``` |
| //! |
| //! Then `"Accept"` is a `HeaderName` while `"text/html"` is a `HeaderValue`. |
| //! Each of these is a dedicated type to allow for a number of interesting |
| //! optimizations and to also encode the static guarantees of each type. For |
| //! example a `HeaderName` is always a valid `&str`, but a `HeaderValue` may |
| //! not be valid UTF-8. |
| //! |
| //! The most common header names are already defined for you as constant values |
| //! in the `header` module of this crate. For example: |
| //! |
| //! ``` |
| //! use http::header::{self, HeaderName}; |
| //! |
| //! let name: HeaderName = header::ACCEPT; |
| //! assert_eq!(name.as_str(), "accept"); |
| //! ``` |
| //! |
| //! You can, however, also parse header names from strings: |
| //! |
| //! ``` |
| //! use http::header::{self, HeaderName}; |
| //! |
| //! let name = "Accept".parse::<HeaderName>().unwrap(); |
| //! assert_eq!(name, header::ACCEPT); |
| //! ``` |
| //! |
| //! Header values can be created from string literals through the `from_static` |
| //! function: |
| //! |
| //! ``` |
| //! use http::HeaderValue; |
| //! |
| //! let value = HeaderValue::from_static("text/html"); |
| //! assert_eq!(value.as_bytes(), b"text/html"); |
| //! ``` |
| //! |
| //! And header values can also be parsed like names: |
| //! |
| //! ``` |
| //! use http::HeaderValue; |
| //! |
| //! let value = "text/html"; |
| //! let value = value.parse::<HeaderValue>().unwrap(); |
| //! ``` |
| //! |
| //! Most HTTP requests and responses tend to come with more than one header, so |
| //! it's not too useful to just work with names and values only! This crate also |
| //! provides a `HeaderMap` type which is a specialized hash map for keys as |
| //! `HeaderName` and generic values. This type, like header names, is optimized |
| //! for common usage but should continue to scale with your needs over time. |
| //! |
| //! # URIs |
| //! |
| //! Each HTTP `Request` has an associated URI with it. This may just be a path |
| //! like `/index.html` but it could also be an absolute URL such as |
| //! `https://www.rust-lang.org/index.html`. A `URI` has a number of accessors to |
| //! interpret it: |
| //! |
| //! ``` |
| //! use http::Uri; |
| //! use http::uri::Scheme; |
| //! |
| //! let uri = "https://www.rust-lang.org/index.html".parse::<Uri>().unwrap(); |
| //! |
| //! assert_eq!(uri.scheme(), Some(&Scheme::HTTPS)); |
| //! assert_eq!(uri.host(), Some("www.rust-lang.org")); |
| //! assert_eq!(uri.path(), "/index.html"); |
| //! assert_eq!(uri.query(), None); |
| //! ``` |
| |
| </span><span class="attribute">#![deny(warnings, missing_docs, missing_debug_implementations)] |
| |
| #[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>doc_comment; |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="macro">doctest!</span>(<span class="string">"../README.md"</span>); |
| |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>convert; |
| |
| <span class="kw">pub mod </span>header; |
| <span class="kw">pub mod </span>method; |
| <span class="kw">pub mod </span>request; |
| <span class="kw">pub mod </span>response; |
| <span class="kw">pub mod </span>status; |
| <span class="kw">pub mod </span>uri; |
| <span class="kw">pub mod </span>version; |
| |
| <span class="kw">mod </span>byte_str; |
| <span class="kw">mod </span>error; |
| <span class="kw">mod </span>extensions; |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::error::{Error, <span class="prelude-ty">Result</span>}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::extensions::Extensions; |
| <span class="attribute">#[doc(no_inline)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::header::{HeaderMap, HeaderName, HeaderValue}; |
| <span class="kw">pub use </span><span class="kw">crate</span>::method::Method; |
| <span class="kw">pub use </span><span class="kw">crate</span>::request::Request; |
| <span class="kw">pub use </span><span class="kw">crate</span>::response::Response; |
| <span class="kw">pub use </span><span class="kw">crate</span>::status::StatusCode; |
| <span class="kw">pub use </span><span class="kw">crate</span>::uri::Uri; |
| <span class="kw">pub use </span><span class="kw">crate</span>::version::Version; |
| |
| <span class="kw">fn </span>_assert_types() { |
| <span class="kw">fn </span>assert_send<T: Send>() {} |
| <span class="kw">fn </span>assert_sync<T: Sync>() {} |
| |
| assert_send::<Request<()>>(); |
| assert_send::<Response<()>>(); |
| |
| assert_sync::<Request<()>>(); |
| assert_sync::<Response<()>>(); |
| } |
| |
| <span class="kw">mod </span>sealed { |
| <span class="doccomment">/// Private trait to this crate to prevent traits from being implemented in |
| /// downstream crates. |
| </span><span class="kw">pub trait </span>Sealed {} |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="http" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
