-
Notifications
You must be signed in to change notification settings - Fork 14
/
Bento.Parser.html
230 lines (161 loc) · 5.37 KB
/
Bento.Parser.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
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.11.4">
<title>Bento.Parser – bento v0.9.1</title>
<link rel="stylesheet" href="dist/app-1e374caa3d.css" />
<script src="dist/sidebar_items.js"></script>
</head>
<body data-type="modules">
<div class="main">
<button class="sidebar-toggle">
<i class="icon-menu"></i>
</button>
<section class="sidebar">
<button class="sidebar-toggle">
<i class="icon-menu"></i>
</button>
<a href="api-reference.html" class="sidebar-projectLink">
<div class="sidebar-projectDetails">
<h1 class="sidebar-projectName">
bento
</h1>
<h2 class="sidebar-projectVersion">
v0.9.1
</h2>
</div>
</a>
<div class="sidebar-search">
<i class="icon-search"></i>
<input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
</div>
<ul class="sidebar-listNav">
<li><a id="extras-list" href="#full-list">Pages</a></li>
<li><a id="modules-list" href="#full-list">Modules</a></li>
<li><a id="exceptions-list" href="#full-list">Exceptions</a></li>
<li><a id="protocols-list" href="#full-list">Protocols</a></li>
</ul>
<ul id="full-list" class="sidebar-fullList"></ul>
<div class="sidebar-noResults"></div>
</section>
<section class="content">
<div id="content" class="content-inner">
<h1>
<small class="visible-xs">bento v0.9.1</small>
Bento.Parser
</h1>
<section id="moduledoc" class="docstring">
<p>A BEP-3 conforming Bencoding parser.</p>
<p>See: http://bittorrent.org/beps/bep_0003.html and https://wiki.theory.org/BitTorrentSpecification#Bencoding</p>
</section>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="icon-link"></i>
</a>
Summary
</h1>
<div class="summary-types summary">
<h2>
<a href="#types">Types</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#t:t/0">t()</a>
</div>
</div>
</div>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#parse/1">parse(iodata)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#parse!/1">parse!(iodata)</a>
</div>
</div>
</div>
</section>
<section id="types" class="types details-list">
<h1 class="section-heading">
<a class="hover-link" href="#types">
<i class="icon-link"></i>
</a>
Types
</h1>
<div class="types-list">
<div id="t:t/0" class="type-detail">
<pre><code class="elixir"><a href="#t:t/0">t</a> :: integer | <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a> | list | map</code></pre>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="icon-link"></i>
</a>
Functions
</h1>
<div class="detail" id="parse/1">
<div class="detail-header">
<a href="#parse/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">parse(iodata)</span>
</div>
<div class="specs">
<h4 class="specs-title">Specs</h4>
<div class="specs-list">
<pre><code class="elixir">parse(iodata) ::
{:ok, <a href="#t:t/0">t</a>} |
{:error, :invalid} |
{:error, {:invalid, <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a>}}</code></pre>
</div>
</div>
<section class="docstring">
</section>
</div>
<div class="detail" id="parse!/1">
<div class="detail-header">
<a href="#parse!/1" class="detail-link" title="Link to this function">
<i class="icon-link"></i>
</a>
<span class="signature">parse!(iodata)</span>
</div>
<div class="specs">
<h4 class="specs-title">Specs</h4>
<div class="specs-list">
<pre><code class="elixir">parse!(iodata) :: <a href="#t:t/0">t</a></code></pre>
</div>
</div>
<section class="docstring">
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.11.4),
</span>
<span class="line">
designed by
<a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
</span>
</p>
<button class="night-mode-toggle" />
</footer>
</div>
</section>
</div>
<script src="dist/app-6d2e071366.js"></script>
</body>
</html>