diff options
| author | Teddy Wing | 2020-07-04 18:00:45 +0200 |
|---|---|---|
| committer | Teddy Wing | 2020-07-04 18:14:31 +0200 |
| commit | 52e6473446d3fa3ab03586ce66d45cb99493c0a1 (patch) | |
| tree | b985878838a6925170e12abcd8390cd29890dd5b /src/fastcgi_conduit/lib.rs.html | |
| parent | 95637c5ca6c803bec78687a55afcc2d3f2bf6ff4 (diff) | |
| download | fastcgi-conduit-gh-pages.tar.bz2 | |
Generate docs v0.1.0gh-pages
Diffstat (limited to 'src/fastcgi_conduit/lib.rs.html')
| -rw-r--r-- | src/fastcgi_conduit/lib.rs.html | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/src/fastcgi_conduit/lib.rs.html b/src/fastcgi_conduit/lib.rs.html new file mode 100644 index 0000000..9da5f1c --- /dev/null +++ b/src/fastcgi_conduit/lib.rs.html @@ -0,0 +1,119 @@ +<!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 to the Rust file `src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../fastcgi_conduit/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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> +</pre><div class="example-wrap"><pre class="rust "> +<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">missing_docs</span>)]</span> + +<span class="comment">// Copyright (c) 2020 Teddy Wing</span> +<span class="comment">//</span> +<span class="comment">// This file is part of FastCGI-Conduit.</span> +<span class="comment">//</span> +<span class="comment">// FastCGI-Conduit is free software: you can redistribute it and/or modify</span> +<span class="comment">// it under the terms of the GNU General Public License as published by</span> +<span class="comment">// the Free Software Foundation, either version 3 of the License, or</span> +<span class="comment">// (at your option) any later version.</span> +<span class="comment">//</span> +<span class="comment">// FastCGI-Conduit is distributed in the hope that it will be useful,</span> +<span class="comment">// but WITHOUT ANY WARRANTY; without even the implied warranty of</span> +<span class="comment">// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span> +<span class="comment">// GNU General Public License for more details.</span> +<span class="comment">//</span> +<span class="comment">// You should have received a copy of the GNU General Public License</span> +<span class="comment">// along with FastCGI-Conduit. If not, see <https://www.gnu.org/licenses/>.</span> + +<span class="doccomment">//! # fastcgi-conduit</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! FastCGI-Conduit provides a [Conduit] interface to FastCGI, enabling a</span> +<span class="doccomment">//! high-level API for FastCGI applications.</span> +<span class="doccomment">//!</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! ## Example</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! ``` rust</span> +<span class="doccomment">//! use conduit::{header, Body, RequestExt, Response};</span> +<span class="doccomment">//! use fastcgi_conduit::Server;</span> +<span class="doccomment">//!</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! fn main() {</span> +<span class="doccomment">//! Server::start(handler);</span> +<span class="doccomment">//! }</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! fn handler(_req: &mut dyn RequestExt) -> std::io::Result<Response<Body>> {</span> +<span class="doccomment">//! Ok(</span> +<span class="doccomment">//! Response::builder()</span> +<span class="doccomment">//! .header(header::CONTENT_TYPE, "text/html")</span> +<span class="doccomment">//! .body(Body::from_static(b"<h1>Hello</h1>"))</span> +<span class="doccomment">//! .unwrap()</span> +<span class="doccomment">//! )</span> +<span class="doccomment">//! }</span> +<span class="doccomment">//! ```</span> +<span class="doccomment">//!</span> +<span class="doccomment">//!</span> +<span class="doccomment">//! [Conduit]: ../conduit/index.html</span> + +<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">conduit</span>; +<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">fastcgi</span>; +<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">http</span>; +<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">log</span>; + +<span class="kw">mod</span> <span class="ident">request</span>; +<span class="kw">mod</span> <span class="ident">server</span>; + +<span class="kw">pub</span> <span class="kw">use</span> <span class="ident">server</span>::<span class="ident">Server</span>; +</pre></div> +</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "fastcgi_conduit";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>
\ No newline at end of file |