Skip to content

Commit 0523bb9

Browse files
committed
resync doc
1 parent c3a5588 commit 0523bb9

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

doc/hackney_http.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ uri() = binary()
186186
## Function Index ##
187187

188188

189-
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#execute-1">execute/1</a></td><td>Execute the parser with the current buffer.</td></tr><tr><td valign="top"><a href="#execute-2">execute/2</a></td><td>Execute the parser with the new buffer.</td></tr><tr><td valign="top"><a href="#parser-0">parser/0</a></td><td>Create a new HTTP parser.</td></tr><tr><td valign="top"><a href="#parser-1">parser/1</a></td><td>create a new HTTP parser with options.</td></tr></table>
189+
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#execute-1">execute/1</a></td><td>Execute the parser with the current buffer.</td></tr><tr><td valign="top"><a href="#execute-2">execute/2</a></td><td>Execute the parser with the new buffer.</td></tr><tr><td valign="top"><a href="#get-2">get/2</a></td><td>retrieve a parser property.</td></tr><tr><td valign="top"><a href="#parser-0">parser/0</a></td><td>Create a new HTTP parser.</td></tr><tr><td valign="top"><a href="#parser-1">parser/1</a></td><td>create a new HTTP parser with options.</td></tr></table>
190190

191191

192192
<a name="functions"></a>
@@ -219,6 +219,28 @@ execute(Hparser::#hparser{}, Bin::binary()) -&gt; <a href="#type-parser_result">
219219

220220

221221
Execute the parser with the new buffer
222+
<a name="get-2"></a>
223+
224+
### get/2 ###
225+
226+
227+
<pre><code>
228+
get(Parser::<a href="#type-parser">parser()</a>, Props::atom() | [atom()]) -&gt; any()
229+
</code></pre>
230+
231+
<br></br>
232+
233+
234+
retrieve a parser property.
235+
Properties are:
236+
- `buffer`: internal buffer of the parser (non parsed)
237+
- `state`: the current state (on_status, on_header, on_body, done)
238+
- `version`: HTTP version
239+
- `content_lenght`: content length header if any
240+
- `transfer_encoding`: transfer encoding header if any
241+
- `content_type`: content type header if any
242+
- `location`: location header if any
243+
- `connection`: connection header if any.
222244
<a name="parser-0"></a>
223245

224246
### parser/0 ###

0 commit comments

Comments
 (0)