Skip to content

Commit 6876fa5

Browse files
committed
Update documentation to 1.15.0-RC1
1 parent 398506a commit 6876fa5

37 files changed

+164
-153
lines changed

index.html

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

ring.adapter.jetty.html

Lines changed: 4 additions & 2 deletions
Large diffs are not rendered by default.

ring.handler.dump.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
<!DOCTYPE html PUBLIC ""
2+
"">
3+
<html><head><meta charset="UTF-8" /><title>ring.middleware.content-length documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Ring</span> <span class="project-version">1.15.0-RC1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ring</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>adapter</span></div></div></li><li class="depth-3"><a href="ring.adapter.jetty.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jetty</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>handler</span></div></div></li><li class="depth-3"><a href="ring.handler.dump.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dump</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>middleware</span></div></div></li><li class="depth-3 branch current"><a href="ring.middleware.content-length.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>content-length</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.content-type.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>content-type</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.cookies.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cookies</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.file.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>file</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.file-info.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>file-info</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.flash.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>flash</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.head.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>head</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.keyword-params.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>keyword-params</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.lint.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>lint</span></div></a></li><li class="depth-3"><a href="ring.middleware.multipart-params.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>multipart-params</span></div></a></li><li class="depth-4 branch"><a href="ring.middleware.multipart-params.byte-array.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>byte-array</span></div></a></li><li class="depth-4"><a href="ring.middleware.multipart-params.temp-file.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>temp-file</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.nested-params.html"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>nested-params</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.not-modified.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>not-modified</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.params.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>params</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.reload.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>reload</span></div></a></li><li class="depth-3 branch"><a href="ring.middleware.resource.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>resource</span></div></a></li><li class="depth-3"><a href="ring.middleware.session.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>session</span></div></a></li><li class="depth-4 branch"><a href="ring.middleware.session.cookie.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cookie</span></div></a></li><li class="depth-4 branch"><a href="ring.middleware.session.memory.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>memory</span></div></a></li><li class="depth-4"><a href="ring.middleware.session.store.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>store</span></div></a></li><li class="depth-3"><a href="ring.middleware.stacktrace.html"><div class="inner"><span class="tree" style="top: -114px;"><span class="top" style="height: 123px;"></span><span class="bottom"></span></span><span>stacktrace</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -703px;"><span class="top" style="height: 712px;"></span><span class="bottom"></span></span><span>util</span></div></div></li><li class="depth-3 branch"><a href="ring.util.async.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>async</span></div></a></li><li class="depth-3 branch"><a href="ring.util.io.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>io</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>jakarta</span></div></div></li><li class="depth-4"><a href="ring.util.jakarta.servlet.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>servlet</span></div></a></li><li class="depth-3 branch"><a href="ring.util.mime-type.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>mime-type</span></div></a></li><li class="depth-3 branch"><a href="ring.util.parsing.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>parsing</span></div></a></li><li class="depth-3 branch"><a href="ring.util.request.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>request</span></div></a></li><li class="depth-3 branch"><a href="ring.util.response.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>response</span></div></a></li><li class="depth-3 branch"><a href="ring.util.servlet.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>servlet</span></div></a></li><li class="depth-3 branch"><a href="ring.util.test.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>test</span></div></a></li><li class="depth-3"><a href="ring.util.time.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-2"><a href="ring.websocket.html"><div class="inner"><span class="tree" style="top: -362px;"><span class="top" style="height: 371px;"></span><span class="bottom"></span></span><span>websocket</span></div></a></li><li class="depth-3"><a href="ring.websocket.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="ring.middleware.content-length.html#var-content-length-response"><div class="inner"><span>content-length-response</span></div></a></li><li class="depth-1"><a href="ring.middleware.content-length.html#var-SizableResponseBody"><div class="inner"><span>SizableResponseBody</span></div></a></li><li class="depth-2"><a href="ring.middleware.content-length.html#var-body-size-in-bytes"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>body-size-in-bytes</span></div></a></li><li class="depth-1"><a href="ring.middleware.content-length.html#var-wrap-content-length"><div class="inner"><span>wrap-content-length</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">ring.middleware.content-length</h1><div class="doc"><pre class="plaintext"></pre></div><div class="public anchor" id="var-content-length-response"><h3>content-length-response</h3><h4 class="added">added in 1.15</h4><div class="usage"><code>(content-length-response response)</code></div><div class="doc"><pre class="plaintext">Adds a Content-Length header to the response. See: wrap-content-length.
4+
</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.15.0-RC1/ring-core/src/ring/middleware/content_length.clj#L32">view source</a></div></div><div class="public anchor" id="var-SizableResponseBody"><h3>SizableResponseBody</h3><h4 class="type">protocol</h4><div class="usage"></div><div class="doc"><pre class="plaintext"></pre></div><div class="members"><h4>members</h4><div class="inner"><div class="public anchor" id="var-body-size-in-bytes"><h3>body-size-in-bytes</h3><div class="usage"><code>(body-size-in-bytes body response)</code></div><div class="doc"><pre class="plaintext">Return the number of bytes that an object will require when it is
5+
serialized as a response body. This number will be placed in the
6+
Content-Length header of the response by the wrap-content-length
7+
middleware. If the number of bytes cannot be ascertained, nil is
8+
returned.</pre></div></div></div></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.15.0-RC1/ring-core/src/ring/middleware/content_length.clj#L4">view source</a></div></div><div class="public anchor" id="var-wrap-content-length"><h3>wrap-content-length</h3><h4 class="added">added in 1.15</h4><div class="usage"><code>(wrap-content-length handler)</code></div><div class="doc"><pre class="plaintext">Middleware that adds a Content-Length header to the response, if the
9+
response body satisfies the ContentLength protocol.</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.15.0-RC1/ring-core/src/ring/middleware/content_length.clj#L42">view source</a></div></div></div></body></html>

0 commit comments

Comments
 (0)