Update documentation to 1.11.0-RC1

ring-clojure · Nov 6, 2023 · a1572d7 · a1572d7
1 parent 032c39f
commit a1572d7
Show file tree

Hide file tree

Showing 36 changed files with 203 additions and 133 deletions.
diff --git a/index.html b/index.html
diff --git a/ring.adapter.jetty.html b/ring.adapter.jetty.html
diff --git a/ring.core.protocols.html b/ring.core.protocols.html
diff --git a/ring.handler.dump.html b/ring.handler.dump.html
diff --git a/ring.middleware.content-type.html b/ring.middleware.content-type.html
diff --git a/ring.middleware.cookies.html b/ring.middleware.cookies.html
diff --git a/ring.middleware.file-info.html b/ring.middleware.file-info.html
diff --git a/ring.middleware.file.html b/ring.middleware.file.html
diff --git a/ring.middleware.flash.html b/ring.middleware.flash.html
diff --git a/ring.middleware.head.html b/ring.middleware.head.html
diff --git a/ring.middleware.keyword-params.html b/ring.middleware.keyword-params.html
diff --git a/ring.middleware.lint.html b/ring.middleware.lint.html
diff --git a/ring.middleware.multipart-params.byte-array.html b/ring.middleware.multipart-params.byte-array.html
diff --git a/ring.middleware.multipart-params.html b/ring.middleware.multipart-params.html
diff --git a/ring.middleware.multipart-params.temp-file.html b/ring.middleware.multipart-params.temp-file.html
diff --git a/ring.middleware.nested-params.html b/ring.middleware.nested-params.html
diff --git a/ring.middleware.not-modified.html b/ring.middleware.not-modified.html
diff --git a/ring.middleware.params.html b/ring.middleware.params.html
diff --git a/ring.middleware.reload.html b/ring.middleware.reload.html
diff --git a/ring.middleware.resource.html b/ring.middleware.resource.html
diff --git a/ring.middleware.session.cookie.html b/ring.middleware.session.cookie.html
diff --git a/ring.middleware.session.html b/ring.middleware.session.html
diff --git a/ring.middleware.session.memory.html b/ring.middleware.session.memory.html
diff --git a/ring.middleware.session.store.html b/ring.middleware.session.store.html
diff --git a/ring.middleware.stacktrace.html b/ring.middleware.stacktrace.html
diff --git a/ring.util.io.html b/ring.util.io.html
diff --git a/ring.util.jakarta.servlet.html b/ring.util.jakarta.servlet.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC ""
+    "">
+<html><head><meta charset="UTF-8" /><title>ring.util.jakarta.servlet 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.11.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>core</span></div></div></li><li class="depth-3"><a href="ring.core.protocols.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>protocols</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"><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: -672px;"><span class="top" style="height: 681px;"></span><span class="bottom"></span></span><span>util</span></div></div></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 current"><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: -331px;"><span class="top" style="height: 340px;"></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.util.jakarta.servlet.html#var-build-request-map"><div class="inner"><span>build-request-map</span></div></a></li><li class="depth-1"><a href="ring.util.jakarta.servlet.html#var-defservice"><div class="inner"><span>defservice</span></div></a></li><li class="depth-1"><a href="ring.util.jakarta.servlet.html#var-make-service-method"><div class="inner"><span>make-service-method</span></div></a></li><li class="depth-1"><a href="ring.util.jakarta.servlet.html#var-merge-servlet-keys"><div class="inner"><span>merge-servlet-keys</span></div></a></li><li class="depth-1"><a href="ring.util.jakarta.servlet.html#var-servlet"><div class="inner"><span>servlet</span></div></a></li><li class="depth-1"><a href="ring.util.jakarta.servlet.html#var-update-servlet-response"><div class="inner"><span>update-servlet-response</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">ring.util.jakarta.servlet</h1><div class="doc"><pre class="plaintext">Compatibility functions for turning a ring handler into a Java servlet.
+</pre></div><div class="public anchor" id="var-build-request-map"><h3>build-request-map</h3><div class="usage"><code>(build-request-map request)</code></div><div class="doc"><pre class="plaintext">Create the request map from the HttpServletRequest object.
+</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L30">view source</a></div></div><div class="public anchor" id="var-defservice"><h3>defservice</h3><h4 class="type">macro</h4><div class="usage"><code>(defservice handler)</code><code>(defservice prefix handler)</code><code>(defservice prefix handler options)</code></div><div class="doc"><pre class="plaintext">Defines a service method with an optional prefix suitable for being used by
+genclass to compile a HttpServlet class.
+
+For example:
+
+  (defservice my-handler)
+  (defservice "my-prefix-" my-handler)</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L140">view source</a></div></div><div class="public anchor" id="var-make-service-method"><h3>make-service-method</h3><div class="usage"><code>(make-service-method handler)</code><code>(make-service-method handler options)</code></div><div class="doc"><pre class="plaintext">Turns a handler into a function that takes the same arguments and has the
+same return value as the service method in the HttpServlet class.</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L120">view source</a></div></div><div class="public anchor" id="var-merge-servlet-keys"><h3>merge-servlet-keys</h3><div class="usage"><code>(merge-servlet-keys request-map servlet request response)</code></div><div class="doc"><pre class="plaintext">Associate servlet-specific keys with the request map for use with legacy
+systems.</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L48">view source</a></div></div><div class="public anchor" id="var-servlet"><h3>servlet</h3><div class="usage"><code>(servlet handler)</code><code>(servlet handler options)</code></div><div class="doc"><pre class="plaintext">Create a servlet from a Ring handler.
+</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L130">view source</a></div></div><div class="public anchor" id="var-update-servlet-response"><h3>update-servlet-response</h3><div class="usage"><code>(update-servlet-response response response-map)</code><code>(update-servlet-response response context response-map)</code></div><div class="doc"><pre class="plaintext">Update the HttpServletResponse using a response map. Takes an optional
+AsyncContext.</pre></div><div class="src-link"><a href="http://github.com/ring-clojure/ring/blob/1.11.0-RC1/ring-jakarta-servlet/src/ring/util/jakarta/servlet.clj#L82">view source</a></div></div></div></body></html>