forked from ring-clojure/ring
/
api-index.html
232 lines (229 loc) · 17.5 KB
/
api-index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<html>
<head>
<title>Ring - Index</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Ring</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="adapter.httpcore-api.html" class="wiki_link">adapter.httpcore</a></li><li><a href="adapter.jetty-api.html" class="wiki_link">adapter.jetty</a></li><li><a href="handler.dump-api.html" class="wiki_link">handler.dump</a></li><li><a href="middleware.cookies-api.html" class="wiki_link">middleware.cookies</a></li><li><a href="middleware.file-api.html" class="wiki_link">middleware.file</a></li><li><a href="middleware.file-info-api.html" class="wiki_link">middleware.file-info</a></li><li><a href="middleware.flash-api.html" class="wiki_link">middleware.flash</a></li><li><a href="middleware.keyword-params-api.html" class="wiki_link">middleware.keyword-params</a></li><li><a href="middleware.lint-api.html" class="wiki_link">middleware.lint</a></li><li><a href="middleware.multipart-params-api.html" class="wiki_link">middleware.multipart-params</a></li><li><a href="middleware.nested-params-api.html" class="wiki_link">middleware.nested-params</a></li><li><a href="middleware.params-api.html" class="wiki_link">middleware.params</a></li><li><a href="middleware.reload-api.html" class="wiki_link">middleware.reload</a></li><li><a href="middleware.session-api.html" class="wiki_link">middleware.session</a></li><li><a href="middleware.stacktrace-api.html" class="wiki_link">middleware.stacktrace</a></li><li><a href="middleware.static-api.html" class="wiki_link">middleware.static</a></li><li><a href="util.codec-api.html" class="wiki_link">util.codec</a></li><li><a href="util.response-api.html" class="wiki_link">util.response</a></li><li><a href="util.servlet-api.html" class="wiki_link">util.servlet</a></li><li><a href="util.test-api.html" class="wiki_link">util.test</a></li>
</ul>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables in <span class="project-name-span">Ring</span></h1>
<div class="shortcuts">
Shortcuts:<br />
<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
<a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
<a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#M">M</a>
<br />
<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
<a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a>
<a href="#V">V</a> <a href="#W">W</a> <a href="#X">X</a> <a href="#Y">Y</a>
<a href="#Z">Z</a>
<br />
<a href="#Other">Other</a>
<br />
</div>
<div id="index-body">
<h2 id="A"><span id="section-head">A</span></h2>
<pre>
<span id="section-content"> <a href="middleware.params-api.html#ring.middleware.params/assoc-param">assoc-param</a><span id="line-content"> function middleware.params Associate a key with a value. If the key already e...
</span></span></pre>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
<span id="section-content"> <a href="util.codec-api.html#ring.util.codec/base64-decode">base64-decode</a><span id="line-content"> function util.codec Decode a base64 encoded string into an array of by...
</span></span><span id="section-content"> <a href="util.codec-api.html#ring.util.codec/base64-encode">base64-encode</a><span id="line-content"> function util.codec Encode an array of bytes into a base64 encoded str...
</span></span><span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/build-request-map">build-request-map</a><span id="line-content"> function util.servlet Create the request map from the HttpServletRequest...
</span></span></pre>
</div><div id="index-body">
<h2 id="C"><span id="section-head">C</span></h2>
<pre>
<span id="section-content"> <a href="util.response-api.html#ring.util.response/content-type">content-type</a><span id="line-content"> function util.response Returns an updated Ring response with the a Conten...
</span></span></pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
<span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/defservice">defservice</a><span id="line-content"> macro util.servlet Defines a service method with an optional prefix s...
</span></span></pre>
</div><div id="index-body">
<h2 id="E"><span id="section-head">E</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="F"><span id="section-head">F</span></h2>
<pre>
<span id="section-content"> <a href="util.response-api.html#ring.util.response/file-response">file-response</a><span id="line-content"> function util.response Returns a Ring response to serve a static file, or...
</span></span></pre>
</div><div id="index-body">
<h2 id="G"><span id="section-head">G</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="H"><span id="section-head">H</span></h2>
<pre>
<span id="section-content"> <a href="handler.dump-api.html#ring.handler.dump/handle-dump">handle-dump</a><span id="line-content"> function handler.dump Returns a response tuple corresponding to an HTML ...
</span></span><span id="section-content"> <a href="util.response-api.html#ring.util.response/header">header</a><span id="line-content"> function util.response Returns an updated Ring response with the specifie...
</span></span></pre>
</div><div id="index-body">
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="J"><span id="section-head">J</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="K"><span id="section-head">K</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="L"><span id="section-head">L</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="middleware.file-info-api.html#ring.middleware.file-info/make-http-format">make-http-format</a><span id="line-content"> function middleware.file-info Formats or parses dates into HTTP date format (R...
</span></span><span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/make-service-method">make-service-method</a><span id="line-content"> function util.servlet Turns a handler into a function that takes the sam...
</span></span><span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/merge-servlet-keys">merge-servlet-keys</a><span id="line-content"> function util.servlet Associate servlet-specific keys with the request m...
</span></span></pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="O"><span id="section-head">O</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="P"><span id="section-head">P</span></h2>
<pre>
<span id="section-content"> <a href="middleware.multipart-params-api.html#ring.middleware.multipart-params/parse-multipart-params">parse-multipart-params</a><span id="line-content"> function middleware.multipart-params Parse a map of multipart parameters from ...
</span></span><span id="section-content"> <a href="middleware.nested-params-api.html#ring.middleware.nested-params/parse-nested-keys">parse-nested-keys</a><span id="line-content"> function middleware.nested-params Parse a parameter name into a list of keys u...
</span></span></pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="R"><span id="section-head">R</span></h2>
<pre>
<span id="section-content"> <a href="util.response-api.html#ring.util.response/redirect">redirect</a><span id="line-content"> function util.response Returns a Ring response for an HTTP 302 redirect..
</span></span><span id="section-content"> <a href="util.response-api.html#ring.util.response/resource-response">resource-response</a><span id="line-content"> function util.response Returns a Ring response to serve a packaged resour...
</span></span><span id="section-content"> <a href="util.response-api.html#ring.util.response/response">response</a><span id="line-content"> function util.response Returns a skeletal Ring response with the given bo...
</span></span><span id="section-content"> <a href="adapter.jetty-api.html#ring.adapter.jetty/run-jetty">run-jetty</a><span id="line-content"> function adapter.jetty Serve the given handler according to the options. ...
</span></span></pre>
</div><div id="index-body">
<h2 id="S"><span id="section-head">S</span></h2>
<pre>
<span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/servlet">servlet</a><span id="line-content"> function util.servlet Create a servlet from a Ring handler...
</span></span><span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/set-headers">set-headers</a><span id="line-content"> function util.servlet Update a HttpServletResponse with a map of headers...
</span></span><span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/set-status">set-status</a><span id="line-content"> function util.servlet Update a HttpServletResponse with a status code..
</span></span><span id="section-content"> <a href="util.response-api.html#ring.util.response/status">status</a><span id="line-content"> function util.response Returns an updated Ring response with the given st...
</span></span></pre>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
<span id="section-content"> <a href="util.servlet-api.html#ring.util.servlet/update-servlet-response">update-servlet-response</a><span id="line-content"> function util.servlet Update the HttpServletResponse using a response ma...
</span></span><span id="section-content"> <a href="util.codec-api.html#ring.util.codec/url-decode">url-decode</a><span id="line-content"> function util.codec Returns the form-url-decoded version of the given ...
</span></span><span id="section-content"> <a href="util.codec-api.html#ring.util.codec/url-encode">url-encode</a><span id="line-content"> function util.codec Returns the form-url-encoded ersion of the given s...
</span></span></pre>
</div><div id="index-body">
<h2 id="V"><span id="section-head">V</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="W"><span id="section-head">W</span></h2>
<pre>
<span id="section-content"> <a href="middleware.cookies-api.html#ring.middleware.cookies/wrap-cookies">wrap-cookies</a><span id="line-content"> function middleware.cookies Parses the cookies in the request map, then assocs...
</span></span><span id="section-content"> <a href="middleware.file-api.html#ring.middleware.file/wrap-file">wrap-file</a><span id="line-content"> function middleware.file Wrap an app such that the directory at the given r...
</span></span><span id="section-content"> <a href="middleware.file-info-api.html#ring.middleware.file-info/wrap-file-info">wrap-file-info</a><span id="line-content"> function middleware.file-info Wrap an app such that responses with a file a bo...
</span></span><span id="section-content"> <a href="middleware.flash-api.html#ring.middleware.flash/wrap-flash">wrap-flash</a><span id="line-content"> function middleware.flash If a :flash key is set on the response by the hand...
</span></span><span id="section-content"> <a href="middleware.keyword-params-api.html#ring.middleware.keyword-params/wrap-keyword-params">wrap-keyword-params</a><span id="line-content"> function middleware.keyword-params Middleware that converts the string-keyed :...
</span></span><span id="section-content"> <a href="middleware.lint-api.html#ring.middleware.lint/wrap-lint">wrap-lint</a><span id="line-content"> function middleware.lint Wrap an app to validate incoming requests and outg...
</span></span><span id="section-content"> <a href="middleware.multipart-params-api.html#ring.middleware.multipart-params/wrap-multipart-params">wrap-multipart-params</a><span id="line-content"> function middleware.multipart-params Middleware to parse multipart parameters ...
</span></span><span id="section-content"> <a href="middleware.nested-params-api.html#ring.middleware.nested-params/wrap-nested-params">wrap-nested-params</a><span id="line-content"> function middleware.nested-params Middleware to converts a flat map of paramet...
</span></span><span id="section-content"> <a href="middleware.params-api.html#ring.middleware.params/wrap-params">wrap-params</a><span id="line-content"> function middleware.params Middleware to parse urlencoded parameters from the...
</span></span><span id="section-content"> <a href="middleware.reload-api.html#ring.middleware.reload/wrap-reload">wrap-reload</a><span id="line-content"> function middleware.reload Wrap an app such that before a request is passed t...
</span></span><span id="section-content"> <a href="middleware.session-api.html#ring.middleware.session/wrap-session">wrap-session</a><span id="line-content"> function middleware.session Reads in the current HTTP session map, and adds it...
</span></span><span id="section-content"> <a href="middleware.stacktrace-api.html#ring.middleware.stacktrace/wrap-stacktrace">wrap-stacktrace</a><span id="line-content"> function middleware.stacktrace Wrap an app such that exceptions are caught, a ...
</span></span><span id="section-content"> <a href="middleware.stacktrace-api.html#ring.middleware.stacktrace/wrap-stacktrace-log">wrap-stacktrace-log</a><span id="line-content"> function middleware.stacktrace Wrap an app such that exceptions are logged to ...
</span></span><span id="section-content"> <a href="middleware.stacktrace-api.html#ring.middleware.stacktrace/wrap-stacktrace-web">wrap-stacktrace-web</a><span id="line-content"> function middleware.stacktrace Wrap an app such that exceptions are caught and...
</span></span><span id="section-content"> <a href="middleware.static-api.html#ring.middleware.static/wrap-static">wrap-static</a><span id="line-content"> function middleware.static Like ring.file, but takes an additional statics, a...
</span></span></pre>
</div><div id="index-body">
<h2 id="X"><span id="section-head">X</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Y"><span id="section-head">Y</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Z"><span id="section-head">Z</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="Other"><span id="section-head">Other</span></h2>
<pre>
</pre>
</div>
<style type="text/css">
#AllContentContainer {min-width: 96em;}
</style>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2009-2010 Mark McGranaghan</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>