180 lines
No EOL
12 KiB
HTML
180 lines
No EOL
12 KiB
HTML
<!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="API documentation for the Rust `SimpleServer` struct in crate `solicit`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, SimpleServer">
|
||
|
||
<title>solicit::server::SimpleServer - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
<p class='location'><a href='../index.html'>solicit</a>::<wbr><a href='index.html'>server</a></p><script>window.sidebarCurrent = {name: 'SimpleServer', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content struct">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>solicit</a>::<wbr><a href='index.html'>server</a>::<wbr><a class='struct' href=''>SimpleServer</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a id='src-1945' class='srclink' href='../../src/solicit/server/mod.rs.html#72-75' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct SimpleServer<TS, H> <span class='where'>where TS: <a class='trait' href='../../solicit/http/transport/trait.TransportStream.html' title='solicit::http::transport::TransportStream'>TransportStream</a>, H: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.FnMut.html' title='core::ops::FnMut'>FnMut</a>(<a class='struct' href='../../solicit/server/struct.ServerRequest.html' title='solicit::server::ServerRequest'>ServerRequest</a>) -> <a class='struct' href='../../solicit/http/struct.Response.html' title='solicit::http::Response'>Response</a></span> {
|
||
// some fields omitted
|
||
}</pre><div class='docblock'><p>The struct implements a simple HTTP/2 server that allows users to register a request handler (a
|
||
callback taking a <code>ServerRequest</code> and returning a <code>Response</code>) which is run on all received
|
||
requests.</p>
|
||
|
||
<p>The <code>handle_next</code> method needs to be called regularly in order to have the server process
|
||
received frames, as well as send out the responses.</p>
|
||
|
||
<p>This is an exceedingly simple implementation of an HTTP/2 server and is mostly an example of
|
||
how the <code>solicit::http</code> API can be used to make one.</p>
|
||
|
||
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
|
||
<pre class='rust rust-example-rendered'>
|
||
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>solicit</span>;
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>str</span>;
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>net</span>::{<span class='ident'>TcpListener</span>, <span class='ident'>TcpStream</span>};
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>thread</span>;
|
||
|
||
<span class='kw'>use</span> <span class='ident'>solicit</span>::<span class='ident'>server</span>::<span class='ident'>SimpleServer</span>;
|
||
|
||
<span class='kw'>use</span> <span class='ident'>solicit</span>::<span class='ident'>http</span>::<span class='ident'>Response</span>;
|
||
|
||
<span class='kw'>fn</span> <span class='ident'>main</span>() {
|
||
<span class='kw'>fn</span> <span class='ident'>handle_client</span>(<span class='ident'>stream</span>: <span class='ident'>TcpStream</span>) {
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>server</span> <span class='op'>=</span> <span class='ident'>SimpleServer</span>::<span class='ident'>new</span>(<span class='ident'>stream</span>, <span class='op'>|</span><span class='ident'>req</span><span class='op'>|</span> {
|
||
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"Received request:"</span>);
|
||
<span class='kw'>for</span> <span class='ident'>header</span> <span class='kw'>in</span> <span class='ident'>req</span>.<span class='ident'>headers</span>.<span class='ident'>iter</span>() {
|
||
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>" {}: {}"</span>,
|
||
<span class='ident'>str</span>::<span class='ident'>from_utf8</span>(<span class='kw-2'>&</span><span class='ident'>header</span>.<span class='number'>0</span>).<span class='ident'>unwrap</span>(),
|
||
<span class='ident'>str</span>::<span class='ident'>from_utf8</span>(<span class='kw-2'>&</span><span class='ident'>header</span>.<span class='number'>1</span>).<span class='ident'>unwrap</span>());
|
||
}
|
||
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"Body:\n{}"</span>, <span class='ident'>str</span>::<span class='ident'>from_utf8</span>(<span class='kw-2'>&</span><span class='ident'>req</span>.<span class='ident'>body</span>).<span class='ident'>unwrap</span>());
|
||
|
||
<span class='comment'>// Return a dummy response for every request</span>
|
||
<span class='ident'>Response</span> {
|
||
<span class='ident'>headers</span>: <span class='macro'>vec</span><span class='macro'>!</span>[
|
||
(<span class='string'>b":status"</span>.<span class='ident'>to_vec</span>(), <span class='string'>b"200"</span>.<span class='ident'>to_vec</span>()),
|
||
(<span class='string'>b"x-solicit"</span>.<span class='ident'>to_vec</span>(), <span class='string'>b"Hello, World!"</span>.<span class='ident'>to_vec</span>()),
|
||
],
|
||
<span class='ident'>body</span>: <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>65</span>],
|
||
<span class='ident'>stream_id</span>: <span class='ident'>req</span>.<span class='ident'>stream_id</span>,
|
||
}
|
||
}).<span class='ident'>unwrap</span>();
|
||
<span class='kw'>while</span> <span class='kw'>let</span> <span class='prelude-val'>Ok</span>(_) <span class='op'>=</span> <span class='ident'>server</span>.<span class='ident'>handle_next</span>() {}
|
||
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"Server done (client disconnected)"</span>);
|
||
}
|
||
|
||
<span class='kw'>let</span> <span class='ident'>listener</span> <span class='op'>=</span> <span class='ident'>TcpListener</span>::<span class='ident'>bind</span>(<span class='string'>"127.0.0.1:8080"</span>).<span class='ident'>unwrap</span>();
|
||
<span class='kw'>for</span> <span class='ident'>stream</span> <span class='kw'>in</span> <span class='ident'>listener</span>.<span class='ident'>incoming</span>() {
|
||
<span class='kw'>let</span> <span class='ident'>stream</span> <span class='op'>=</span> <span class='ident'>stream</span>.<span class='ident'>unwrap</span>();
|
||
<span class='ident'>thread</span>::<span class='ident'>spawn</span>(<span class='kw'>move</span> <span class='op'>||</span> {
|
||
<span class='ident'>handle_client</span>(<span class='ident'>stream</span>)
|
||
});
|
||
}
|
||
}</pre>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<TS, H> <a class='struct' href='../../solicit/server/struct.SimpleServer.html' title='solicit::server::SimpleServer'>SimpleServer</a><TS, H> <span class='where'>where TS: <a class='trait' href='../../solicit/http/transport/trait.TransportStream.html' title='solicit::http::transport::TransportStream'>TransportStream</a>, H: <a class='trait' href='https://doc.rust-lang.org/nightly/core/ops/trait.FnMut.html' title='core::ops::FnMut'>FnMut</a>(<a class='struct' href='../../solicit/server/struct.ServerRequest.html' title='solicit::server::ServerRequest'>ServerRequest</a>) -> <a class='struct' href='../../solicit/http/struct.Response.html' title='solicit::http::Response'>Response</a></span></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-1950' class='srclink' href='../../src/solicit/server/mod.rs.html#77-161' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>(stream: TS, handler: H) -> <a class='type' href='../../solicit/http/type.HttpResult.html' title='solicit::http::HttpResult'>HttpResult</a><<a class='struct' href='../../solicit/server/struct.SimpleServer.html' title='solicit::server::SimpleServer'>SimpleServer</a><TS, H>></code></h4>
|
||
<div class='docblock'><p>Creates a new <code>SimpleServer</code> that will use the given <code>TransportStream</code> to communicate to
|
||
the client. Assumes that the stream is fully uninitialized -- no preface sent or read yet.</p>
|
||
</div><h4 id='method.handle_next' class='method'><code>fn <a href='#method.handle_next' class='fnname'>handle_next</a>(&mut self) -> <a class='type' href='../../solicit/http/type.HttpResult.html' title='solicit::http::HttpResult'>HttpResult</a><<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.tuple.html'>()</a>></code></h4>
|
||
<div class='docblock'><p>Handles the next incoming frame, blocking to receive it if nothing is available on the
|
||
underlying stream.</p>
|
||
|
||
<p>Handling the frame can trigger the handler callback. Any responses returned by the handler
|
||
are immediately flushed out to the client (blocking the call until it's done).</p>
|
||
</div></div></section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand all sections</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "solicit";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../jquery.js"></script>
|
||
<script src="../../main.js"></script>
|
||
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |