Skip to content

Commit 03cc301

Browse files
trikkotrikko
committed
docs
1 parent 60b83b0 commit 03cc301

14 files changed

+144
-33
lines changed

‎docs/file_hashes.json

+1-1
Large diffs are not rendered by default.

‎docs/serverino.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h1>Module serverino</h1><p>Serverino is a small and ready-to-go http server, in
9191
<code class="lang-d"><a href="./serverino/config/priority.html" title="serverino.config.priority"><span class="pln">priority</span></a></code> (default is 0). The first endpoint that write something to the output is the one that will respond to the request.
9292
</p>
9393

94-
<p> The <code class="lang-d"><a href="./serverino/config/route.html" title="serverino.config.route"><span class="pln">route</span></a></code> attribute can be used to filter the requests that are passed to the endpoint, using a uri or a <code class="lang-d"><span class="typ">bool </span><span class="kwd">delegate</span><span class="pun">(</span><span class="typ">Request </span><span class="pln">r</span><span class="pun">)</span></code> argument.
94+
<p> The <code class="lang-d"><a href="./serverino/config/route.html" title="serverino.config.route"><span class="pln">route</span></a></code> attribute can be used to filter the requests that are passed to the endpoint, using a path or a <code class="lang-d"><span class="typ">bool </span><span class="kwd">delegate</span><span class="pun">(</span><span class="typ">Request </span><span class="pln">r</span><span class="pun">)</span></code> argument.
9595
In this example, only requests to <code class="lang-d"><span class="pun">/</span><span class="pln">hello</span></code> are passed to the <code class="lang-d"><span class="pln">hello</span></code> endpoint. The <code class="lang-d"><a href="./serverino/config/route.html" title="serverino.config.route"><span class="pln">route</span></a></code> attribute can be used multiple times to specify multiple routes also using a delegate.
9696
</p>
9797
</section>
@@ -100,11 +100,11 @@ <h1>Module serverino</h1><p>Serverino is a small and ready-to-go http server, in
100100
</div>
101101
<footer>
102102
<div id="license-info">
103-
104-
105-
103+
104+
105+
106106
</div>
107107
</footer>
108108
</div>
109109
</body>
110-
</html>
110+
</html>

‎docs/serverino/config.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,9 @@ <h2>Aliases</h2>
192192
</a>
193193
</td>
194194
<td>
195-
<code class="prettyprint lang-d"><a href="../serverino/config/route.html"><span class="pln">route</span></a>!((r)=>compareUri!uri(r))</code>
195+
<code class="prettyprint lang-d"><a href="../serverino/config/route.html"><span class="pln">route</span></a>!((r)=>comparePath!path(r))</code>
196196
</td>
197-
<td>UDA. You can use to filter requests using a uri.
197+
<td>UDA. You can use to filter requests using a path.
198198
</td>
199199
</tr>
200200
</table>

‎docs/serverino/config/route.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -75,16 +75,16 @@ <h1>route - multiple declarations</h1>
7575

7676
<section><h3>Example</h3>
7777
<pre class="code"><code class="lang-d"><span class="pun">@<a href="../../serverino/config/endpoint.html"></span><span class="pln">endpoint</span></a><span class="pln">
78-
</span><span class="pun">@</span><span class="pln">route</span><span class="pun">!(</span><span class="pln">x </span><span class="pun">=&gt; </span><span class="pln">x<wbr/></span><span class="pun">.</span><span class="pln">uri<wbr/></span><span class="pun">.</span><span class="pln">startsWith</span><span class="pun">(</span><span class="str">"/api"</span><span class="pun">))
78+
</span><span class="pun">@</span><span class="pln">route</span><span class="pun">!(</span><span class="pln">x </span><span class="pun">=&gt; </span><span class="pln">x<wbr/></span><span class="pun">.</span><span class="pln">path<wbr/></span><span class="pun">.</span><span class="pln">startsWith</span><span class="pun">(</span><span class="str">"/api"</span><span class="pun">))
7979
</span><span class="typ">void </span><span class="pln">api</span><span class="pun">(</span><span class="typ">Request </span><span class="pln">r</span><span class="pun">, </span><span class="typ">Output </span><span class="pln">o</span><span class="pun">) { ... }</span></code></pre>
8080
</section>
81-
<h2 id="1">Alias route</h2><p>UDA. You can use to filter requests using a uri.
81+
<h2 id="1">Alias route</h2><p>UDA. You can use to filter requests using a path.
8282
</p>
8383
<div class="prototype">
8484
<code class="lang-d">
8585
<div class="single-prototype">
86-
<span class="kwd">alias</span> <span class="pln">route</span>(<span class="typ">string</span> uri)
87-
<span class="pun">=</span> <a href="../../serverino/config/route.html"><span class="pln">route</span></a>!((r)=>compareUri!uri(r))<span class="pun">;</span>
86+
<span class="kwd">alias</span> <span class="pln">route</span>(<span class="typ">string</span> path)
87+
<span class="pun">=</span> <a href="../../serverino/config/route.html"><span class="pln">route</span></a>!((r)=>comparePath!path(r))<span class="pun">;</span>
8888
</div>
8989
</code>
9090
</div>

‎docs/serverino/interfaces.html

+9
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,15 @@ <h2>Enums</h2>
128128
</code>
129129
</td>
130130
<td>HTTP version used in request
131+
</td>
132+
</tr>
133+
<tr>
134+
<td>
135+
<code>
136+
<a id="OnFileServed" class="public" href="../serverino/interfaces/OnFileServed.html">OnFileServed</a>
137+
</code>
138+
</td>
139+
<td>Used by Output.serveFile
131140
</td>
132141
</tr>
133142
</table>

‎docs/serverino/interfaces/OnFileServed.html

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="UTF-8"/>
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
6+
<title>Enum OnFileServed</title>
7+
<link rel="stylesheet" href="../../css/style.min.css"/>
8+
<script type="text/javascript" src="../../js/script.min.js"></script>
9+
</head>
10+
<body onload="setupDdox();">
11+
<header></header>
12+
<nav id="main-nav">
13+
<div>
14+
<noscript>
15+
<p style="color: red">The search functionality needs JavaScript enabled</p>
16+
</noscript>
17+
<div id="symbolSearchPane" style="display: none">
18+
<form action="#" method="GET">
19+
<input id="symbolSearch" type="text" name="q" placeholder="Search for symbols" autocomplete="off" onchange="performSymbolSearch(24);" onkeypress="this.onchange();" onpaste="this.onchange();" oninput="this.onchange();" autofocus/>
20+
</form>
21+
<ul id="symbolSearchResults" class="symbolList" style="display: none"></ul><script type="application/javascript" src="../../symbols.js"></script><script type="application/javascript">var symbolSearchRootDir = "../../";
22+
document.getElementById('symbolSearchPane').style.display = 'block';</script>
23+
</div>
24+
<ul class="tree-view">
25+
<li class="tree-view ">
26+
<div class="package ">
27+
<a href="../../serverino.html">serverino</a>
28+
</div>
29+
<ul class="tree-view">
30+
<li>
31+
<div class="module ">
32+
<a href="../../serverino/config.html">config</a>
33+
</div>
34+
</li>
35+
<li>
36+
<div class="module selected">
37+
<a href="../../serverino/interfaces.html">interfaces</a>
38+
</div>
39+
</li>
40+
</ul>
41+
</li>
42+
</ul>
43+
</div>
44+
<p id="main-nav-footer">
45+
Built with
46+
<a href="https://github.com/MartinNowak/scod">scod</a>
47+
</p>
48+
</nav>
49+
<div id="main-contents">
50+
<div>
51+
<h1>Enum OnFileServed</h1><p>Used by Output.serveFile
52+
</p>
53+
<div class="prototype">
54+
<code class="lang-d">
55+
<div class="single-prototype">
56+
<span class="kwd">enum</span> <span class="typ">OnFileServed</span>
57+
<span class="pun">:</span> <span class="typ">int</span> <span class="pun">{ ... }</span>
58+
</div>
59+
</code>
60+
</div>
61+
62+
<section><h2>Enum members</h2>
63+
<table>
64+
<col class="caption"/>
65+
<tr>
66+
<th>Name</th><th>Description</th>
67+
</tr>
68+
<tr>
69+
<td id="DeleteFile">
70+
<code>DeleteFile</code>
71+
</td>
72+
<td>Delete the file after sending it
73+
</td>
74+
</tr>
75+
<tr>
76+
<td id="KeepFile">
77+
<code>KeepFile</code>
78+
</td>
79+
<td>Keep the file on disk
80+
</td>
81+
</tr>
82+
</table>
83+
</section>
84+
85+
</div>
86+
<footer>
87+
<div id="license-info">
88+
89+
90+
91+
</div>
92+
</footer>
93+
</div>
94+
</body>
95+
</html>

‎docs/serverino/interfaces/Output.addHeader.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<div id="main-contents">
5050
<div>
5151
<h1>Function Output.addHeader</h1><p>Add a http header.
52-
You can't set <code class="lang-d"><span class="pln">content</span><span class="pun">-</span><span class="pln">length</span></code>, <code class="lang-d"><a href="../../serverino/interfaces/Output.status.html"><span class="pln">status</span></a></code> or <code class="lang-d"><span class="pln">transfer</span><span class="pun">-</span><span class="pln">encoding</span></code> headers. They are managed by serverino internally.
52+
You can't set <code class="lang-d"><span class="pln">content</span><span class="pun">-</span><span class="pln">length</span></code>, <code class="lang-d"><span class="pln">date</span></code>, <code class="lang-d"><a href="../../serverino/interfaces/Output.status.html"><span class="pln">status</span></a></code> or <code class="lang-d"><span class="pln">transfer</span><span class="pun">-</span><span class="pln">encoding</span></code> headers. They are managed by serverino internally.
5353
</p>
5454
<div class="prototype">
5555
<code class="lang-d">

‎docs/serverino/interfaces/Output.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ <h1>Struct Output</h1><p>A response to user. Default content-type is "text/html"
101101
<span class="tableEntryAnnotation">(key, value)</span>
102102
</td>
103103
<td>Add a http header.
104-
You can't set <code class="lang-d"><span class="pln">content</span><span class="pun">-</span><span class="pln">length</span></code>, <code class="lang-d"><a href="../../serverino/interfaces/Output.status.html"><span class="pln">status</span></a></code> or <code class="lang-d"><span class="pln">transfer</span><span class="pun">-</span><span class="pln">encoding</span></code> headers. They are managed by serverino internally.
104+
You can't set <code class="lang-d"><span class="pln">content</span><span class="pun">-</span><span class="pln">length</span></code>, <code class="lang-d"><span class="pln">date</span></code>, <code class="lang-d"><a href="../../serverino/interfaces/Output.status.html"><span class="pln">status</span></a></code> or <code class="lang-d"><span class="pln">transfer</span><span class="pun">-</span><span class="pln">encoding</span></code> headers. They are managed by serverino internally.
105105
</td>
106106
</tr>
107107
<tr>
@@ -131,7 +131,7 @@ <h1>Struct Output</h1><p>A response to user. Default content-type is "text/html"
131131
</a>
132132
<span class="tableEntryAnnotation">(path, guessMime)</span>
133133
</td>
134-
<td>You can reply with a file. Automagical mime-type detection.
134+
<td>Serve a file from disk. If you want to delete the file after serving it, use <code class="lang-d"><span class="pln">serveFile</span><span class="pun">!(</span><span class="typ">OnFileServed<wbr/></span><span class="pun">.</span><span class="pln">deleteFile</span><span class="pun">)</span></code>.
135135
</td>
136136
</tr>
137137
<tr>

‎docs/serverino/interfaces/Output.serveFile.html

+7-4
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,26 @@
4848
</nav>
4949
<div id="main-contents">
5050
<div>
51-
<h1>Function Output.serveFile</h1><p>You can reply with a file. Automagical mime-type detection.
51+
<h1>Function Output.serveFile</h1><p>Serve a file from disk. If you want to delete the file after serving it, use <code class="lang-d"><span class="pln">serveFile</span><span class="pun">!(</span><span class="typ">OnFileServed<wbr/></span><span class="pun">.</span><span class="pln">deleteFile</span><span class="pun">)</span></code>.
5252
</p>
5353
<div class="prototype">
5454
<code class="lang-d">
5555
<div class="single-prototype">
56-
<span class="typ">bool</span> <span class="pln">serveFile</span>
56+
<span class="typ">bool</span> <span class="pln">serveFile</span>(<a href="../../serverino/interfaces/OnFileServed.html"><span class="typ">OnFileServed</span></a> action<span class="pln"> </span><span class="pun">= </span><span class="typ">OnFileServed<wbr/></span><span class="pun">.</span><span class="typ">KeepFile</span>)
5757
<span class="pun">(</span>
5858
<br/>
59-
&nbsp;&nbsp;<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">path</span><span class="pun">,</span>
59+
&nbsp;&nbsp;<span class="kwd">const </span><span class="typ">string</span> <span class="pln">path</span><span class="pun">,</span>
6060
<br/>
6161
&nbsp;&nbsp;<span class="typ">bool</span> <span class="pln">guessMime</span> <span class="pun">=</span> <span class="kwd">true</span>
6262
<br/>
6363
<span class="pun">)</span><span class="pun">;</span>
6464
</div>
6565
</code>
6666
</div>
67-
67+
<section><pre class="code"><code class="lang-d"><span class="com">// Serve a file from disk
68+
</span><span class="pln">output<wbr/></span><span class="pun">.</span><span class="pln">serveFile</span><span class="pun">(</span><span class="str">"path/to/file.html"</span><span class="pun">);</span></code></pre>
69+
</section>
70+
6871

6972
</div>
7073
<footer>

‎docs/serverino/interfaces/Request.buildId.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h1>Enum member Request.buildId</h1><p>Every time you compile the app this value
6262
&nbsp;&nbsp;<span class="com">// ...</span>
6363
<br/>
6464
&nbsp;&nbsp;<span class="kwd">enum</span> <span class="pln">buildId</span>
65-
<span class="pun">=</span> <span class="str">"4172f3a681159d5a1dc8d378f1eb5116"</span><span class="pun">;</span>
65+
<span class="pun">=</span> <span class="str">"9ad9726cd15b53dc96290b81c04147f6"</span><span class="pun">;</span>
6666
<br/>
6767
&nbsp;&nbsp;<span class="com">// ...</span>
6868
<br/>

‎docs/serverino/interfaces/Request.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ <h1>Struct Request</h1><p>A request from user. Do not store ref to this struct a
6060
</div>
6161
<section><pre class="code"><code class="lang-d"><span class="typ">void </span><span class="pln">handler</span><span class="pun">(</span><span class="typ">Request </span><span class="pln">request</span><span class="pun">, <a href="../../serverino/interfaces/Output.html"></span><span class="typ">Output</span></a><span class="pln"> output</span><span class="pun">)
6262
{
63-
</span><span class="pln">info</span><span class="pun">(</span><span class="str">"You asked for "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">uri</span><span class="pun">, </span><span class="str">" with method "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">method</span><span class="pun">, </span><span class="str">" and params "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">get<wbr/></span><span class="pun">.</span><span class="pln">data</span><span class="pun">);
63+
</span><span class="pln">info</span><span class="pun">(</span><span class="str">"You asked for "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">path</span><span class="pun">, </span><span class="str">" with method "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">method</span><span class="pun">, </span><span class="str">" and params "</span><span class="pun">, </span><span class="pln">request<wbr/></span><span class="pun">.</span><span class="pln">get<wbr/></span><span class="pun">.</span><span class="pln">data</span><span class="pun">);
6464
}</span></code></pre>
6565
</section>
6666

@@ -124,6 +124,13 @@ <h1>Struct Request</h1><p>A request from user. Do not store ref to this struct a
124124
<a href="../../serverino/interfaces/Request.password.html" class="public property"><code>password</code></a><span class="tableEntryAnnotation">[get]</span>
125125
</td>
126126
<td class="typecol"><code class="prettyprint lang-d"><span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span></code></td><td>Basic http authentication password. Safe only if sent thru https!
127+
</td>
128+
</tr>
129+
<tr>
130+
<td>
131+
<a href="../../serverino/interfaces/Request.path.html" class="public property"><code>path</code></a><span class="tableEntryAnnotation">[get]</span>
132+
</td>
133+
<td class="typecol"><code class="prettyprint lang-d"><span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span></code></td><td>The path requested by user
127134
</td>
128135
</tr>
129136
<tr>
@@ -145,13 +152,6 @@ <h1>Struct Request</h1><p>A request from user. Do not store ref to this struct a
145152
<a href="../../serverino/interfaces/Request.route.html" class="public property"><code>route</code></a><span class="tableEntryAnnotation">[get]</span>
146153
</td>
147154
<td class="typecol"><code class="prettyprint lang-d"><span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">[]</span><span class="pun">)</span></code></td><td>The sequence of endpoints called so far
148-
</td>
149-
</tr>
150-
<tr>
151-
<td>
152-
<a href="../../serverino/interfaces/Request.uri.html" class="public property"><code>uri</code></a><span class="tableEntryAnnotation">[get]</span>
153-
</td>
154-
<td class="typecol"><code class="prettyprint lang-d"><span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span></code></td><td>The uri requested by user
155155
</td>
156156
</tr>
157157
<tr>

‎docs/serverino/interfaces/Request.uri.html renamed to ‎docs/serverino/interfaces/Request.path.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8"/>
55
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0"/>
6-
<title>Function Request.uri</title>
6+
<title>Function Request.path</title>
77
<link rel="stylesheet" href="../../css/style.min.css"/>
88
<script type="text/javascript" src="../../js/script.min.js"></script>
99
</head>
@@ -48,12 +48,12 @@
4848
</nav>
4949
<div id="main-contents">
5050
<div>
51-
<h1>Function Request.uri</h1><p>The uri requested by user
51+
<h1>Function Request.path</h1><p>The path requested by user
5252
</p>
5353
<div class="prototype">
5454
<code class="lang-d">
5555
<div class="single-prototype">
56-
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">uri</span><span class="pun">(</span><span class="pun">)</span><span class="pln"> </span><span class="kwd">nothrow @property @nogc @safe const</span><span class="pun">;</span>
56+
<span class="kwd">const</span><span class="pun">(</span><span class="typ">string</span><span class="pun">)</span> <span class="pln">path</span><span class="pun">(</span><span class="pun">)</span><span class="pln"> </span><span class="kwd">nothrow @property @nogc @safe const</span><span class="pun">;</span>
5757
</div>
5858
</code>
5959
</div>

‎docs/sitemap.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
<url><loc>http://127.0.0.1/serverino/interfaces/Cookie.secure.html</loc></url>
5151
<url><loc>http://127.0.0.1/serverino/interfaces/Cookie.this.html</loc></url>
5252
<url><loc>http://127.0.0.1/serverino/interfaces/HttpVersion.html</loc></url>
53+
<url><loc>http://127.0.0.1/serverino/interfaces/OnFileServed.html</loc></url>
5354
<url><loc>http://127.0.0.1/serverino/interfaces/Output.html</loc></url>
5455
<url><loc>http://127.0.0.1/serverino/interfaces/Output.addHeader.html</loc></url>
5556
<url><loc>http://127.0.0.1/serverino/interfaces/Output.addHeader.html</loc></url>
@@ -82,6 +83,7 @@
8283
<url><loc>http://127.0.0.1/serverino/interfaces/Request.Method.html</loc></url>
8384
<url><loc>http://127.0.0.1/serverino/interfaces/Request.method.html</loc></url>
8485
<url><loc>http://127.0.0.1/serverino/interfaces/Request.password.html</loc></url>
86+
<url><loc>http://127.0.0.1/serverino/interfaces/Request.path.html</loc></url>
8587
<url><loc>http://127.0.0.1/serverino/interfaces/Request.post.html</loc></url>
8688
<url><loc>http://127.0.0.1/serverino/interfaces/Request.requestLine.html</loc></url>
8789
<url><loc>http://127.0.0.1/serverino/interfaces/Request.route.html</loc></url>
@@ -90,7 +92,6 @@
9092
<url><loc>http://127.0.0.1/serverino/interfaces/Request.SafeAccess.has.html</loc></url>
9193
<url><loc>http://127.0.0.1/serverino/interfaces/Request.SafeAccess.read.html</loc></url>
9294
<url><loc>http://127.0.0.1/serverino/interfaces/Request.toString.html</loc></url>
93-
<url><loc>http://127.0.0.1/serverino/interfaces/Request.uri.html</loc></url>
9495
<url><loc>http://127.0.0.1/serverino/interfaces/Request.user.html</loc></url>
9596
<url><loc>http://127.0.0.1/serverino/interfaces/Request.worker.html</loc></url>
9697
<url><loc>http://127.0.0.1/serverino/interfaces/WebSocket.html</loc></url>

0 commit comments

Comments
 (0)