-
Notifications
You must be signed in to change notification settings - Fork 82
/
api-index.html
270 lines (254 loc) · 17.2 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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index - Network REPL 0.2.13 API documentation</title>
<link rel="icon" href="static/favicon.png" />
<link rel="shortcut icon" href="static/favicon.png" />
<link rel="stylesheet" href="static/clojure.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/wiki.css" type="text/css" media="all" />
<link rel="stylesheet" href="static/internal.css" type="text/css" media="all" />
<style>.menuWrapper{height: 36px;}</style>
</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 href="index.html" id="Logo"><img src="static/clojure-icon.gif" width="100" height="100" alt="Clojure" /></a>
<h1><a href="index.html" id="page-header" title="page header title">tools.nrepl API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">Network REPL</span> <span id="version">0.2.13</span> API</span><br />
<ul>
<li><a href="index.html" class="wiki_link">Overview</a></li>
<li><a href="api-index.html" class="wiki_link">API Index</a></li>
</ul>
<a class="wiki_link" href="http://clojure.org">Clojure Home</a>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div class="wiki wikiPage" id="content_view">
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">Network REPL</span> <span id="header-version">0.2.13</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">Network REPL</span>.
<!-- TODO: enable this functionality on github?
In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
to get more screen space for the index.
-->
<p>
</p><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>
</pre>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/bencode">bencode</a><span id="line-content"> function clojure.tools.nrepl.transport Returns a Transport implementation that...
</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="index.html#clojure.tools.nrepl/client">client</a><span id="line-content"> function clojure.tools.nrepl Returns a fn of zero and one argument, both of wh...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/client-session">client-session</a><span id="line-content"> function clojure.tools.nrepl Returns a function of one argument. Accepts a me...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/code">code</a><span id="line-content"> macro clojure.tools.nrepl Expands into a string consisting of the macro's b...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/code*">code*</a><span id="line-content"> function clojure.tools.nrepl Returns a single string containing the pr-str'd r...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/combine-responses">combine-responses</a><span id="line-content"> function clojure.tools.nrepl Combines the provided seq of response messages in...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/connect">connect</a><span id="line-content"> function clojure.tools.nrepl Connects to a socket-based REPL at the given host...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
</pre>
</div><div id="index-body">
<h2 id="E"><span id="section-head">E</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.interruptible-eval/*eval*">*eval*</a><span id="line-content"> dynamic var clojure.tools.nrepl.middleware.interruptible-eval Function returning ...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.interruptible-eval/evaluate">evaluate</a><span id="line-content"> function clojure.tools.nrepl.middleware.interruptible-eval Evaluates some code...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="F"><span id="section-head">F</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/->FnTransport">->FnTransport</a><span id="line-content"> function clojure.tools.nrepl.transport Positional factory function for class c...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/fn-transport">fn-transport</a><span id="line-content"> function clojure.tools.nrepl.transport Returns a Transport implementation that...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/FnTransport">FnTransport</a><span id="line-content"> type clojure.tools.nrepl.transport
</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="index.html#clojure.tools.nrepl.server/handle">handle</a><span id="line-content"> function clojure.tools.nrepl.server Handles requests received via [transport] ...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.interruptible-eval/interruptible-eval">interruptible-eval</a><span id="line-content"> function clojure.tools.nrepl.middleware.interruptible-eval Evaluation middlewa...
</span></span>
</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>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.load-file/load-file-code">load-file-code</a><span id="line-content"> dynamic function clojure.tools.nrepl.middleware.load-file Given the contents of a file...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.helpers/load-file-command">load-file-command</a><span id="line-content"> function clojure.tools.nrepl.helpers (If it is available, sending clojure.tool...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.interruptible-eval/*msg*">*msg*</a><span id="line-content"> dynamic var clojure.tools.nrepl.middleware.interruptible-eval The message current...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/message">message</a><span id="line-content"> function clojure.tools.nrepl Sends a message via [client] with a fixed message...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl/new-session">new-session</a><span id="line-content"> function clojure.tools.nrepl Provokes the creation and retention of a new sess...
</span></span>
</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="index.html#clojure.tools.nrepl.transport/piped-transports">piped-transports</a><span id="line-content"> function clojure.tools.nrepl.transport Returns a pair of Transports that read ...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.pr-values/pr-values">pr-values</a><span id="line-content"> function clojure.tools.nrepl.middleware.pr-values Middleware that returns a ha...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/->QueueTransport">->QueueTransport</a><span id="line-content"> function clojure.tools.nrepl.transport Positional factory function for class c...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.interruptible-eval/queue-eval">queue-eval</a><span id="line-content"> function clojure.tools.nrepl.middleware.interruptible-eval Queues the function...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/QueueTransport">QueueTransport</a><span id="line-content"> type clojure.tools.nrepl.transport
</span></span>
</pre>
</div><div id="index-body">
<h2 id="R"><span id="section-head">R</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.bencode/read-bencode">read-bencode</a><span id="line-content"> function clojure.tools.nrepl.bencode Read bencode token from the input stream..
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.bencode/read-netstring">read-netstring</a><span id="line-content"> function clojure.tools.nrepl.bencode Reads a classic netstring from input—an I...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/read-response-value">read-response-value</a><span id="line-content"> function clojure.tools.nrepl Returns the provided response message, replacing ...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/recv">recv</a><span id="line-content"> function clojure.tools.nrepl.transport Reads and returns the next message rece...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.misc/response-for">response-for</a><span id="line-content"> function clojure.tools.nrepl.misc Returns a map containing the :session and :i...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/response-seq">response-seq</a><span id="line-content"> function clojure.tools.nrepl Returns a lazy seq of messages received via the g...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/response-values">response-values</a><span id="line-content"> function clojure.tools.nrepl Given a seq of responses (as from response-seq or...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.misc/returning">returning</a><span id="line-content"> macro clojure.tools.nrepl.misc Executes `body`, returning `x`..
</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="index.html#clojure.tools.nrepl.transport/send">send</a><span id="line-content"> function clojure.tools.nrepl.transport Sends msg. Implementations should retur...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware/set-descriptor!">set-descriptor!</a><span id="line-content"> function clojure.tools.nrepl.middleware Sets the given [descriptor] map as the...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.server/stop-server">stop-server</a><span id="line-content"> function clojure.tools.nrepl.server Stops a server started via `start-server`..
</span></span>
</pre>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/Transport">Transport</a><span id="line-content"> protocol clojure.tools.nrepl.transport Defines the interface for a wire protoc...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/tty">tty</a><span id="line-content"> function clojure.tools.nrepl.transport Returns a Transport implementation suit...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.transport/tty-greeting">tty-greeting</a><span id="line-content"> function clojure.tools.nrepl.transport A greeting fn usable with clojure.tools...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.server/unknown-op">unknown-op</a><span id="line-content"> function clojure.tools.nrepl.server Sends an :unknown-op :error for the given ...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl/url-connect">url-connect</a><span id="line-content"> multimethod clojure.tools.nrepl Connects to an nREPL endpoint identified by the g...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.misc/uuid">uuid</a><span id="line-content"> function clojure.tools.nrepl.misc Returns a new UUID string..
</span></span>
</pre>
</div><div id="index-body">
<h2 id="V"><span id="section-head">V</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl/version">version</a><span id="line-content"> var clojure.tools.nrepl Current version of nREPL, map of :major, :minor, ...
</span></span>
</pre>
</div><div id="index-body">
<h2 id="W"><span id="section-head">W</span></h2>
<pre>
<span id="section-content"> <a href="index.html#clojure.tools.nrepl.ack/wait-for-ack">wait-for-ack</a><span id="line-content"> function clojure.tools.nrepl.ack Waits for a presumably just-launched nREPL se...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.middleware.load-file/wrap-load-file">wrap-load-file</a><span id="line-content"> function clojure.tools.nrepl.middleware.load-file Middleware that evaluates a ...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.bencode/write-bencode">write-bencode</a><span id="line-content"> multimethod clojure.tools.nrepl.bencode Write the given thing to the output strea...
</span></span><span id="section-content"> <a href="index.html#clojure.tools.nrepl.bencode/write-netstring">write-netstring</a><span id="line-content"> function clojure.tools.nrepl.bencode Write the given binary data to the output...
</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 id="copyright" style="text-align: center;">Copyright 2007-2017 by Rich Hickey and the various contributors</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a href="http://www.tomhickey.com" title="Visit Tom Hickey's website.">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>