diff options
| author | Loïc Hoguin <[email protected]> | 2019-04-26 15:59:58 +0200 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2019-04-26 15:59:58 +0200 |
| commit | 352206dee80905b10fa9af97f065ce7bee928d87 (patch) | |
| tree | 5eb48b3c5689c61cb26329317475ee3b67370752 /doc/src/manual/gun.await.asciidoc | |
| parent | f422624ce4527ce5b07bad63c5fda50e13ff4994 (diff) | |
| download | gun-352206dee80905b10fa9af97f065ce7bee928d87.tar.gz gun-352206dee80905b10fa9af97f065ce7bee928d87.tar.bz2 gun-352206dee80905b10fa9af97f065ce7bee928d87.zip | |
Add specs to await functions, document error type better
Diffstat (limited to 'doc/src/manual/gun.await.asciidoc')
| -rw-r--r-- | doc/src/manual/gun.await.asciidoc | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/src/manual/gun.await.asciidoc b/doc/src/manual/gun.await.asciidoc index 21de953..09c244b 100644 --- a/doc/src/manual/gun.await.asciidoc +++ b/doc/src/manual/gun.await.asciidoc @@ -65,13 +65,14 @@ may also be returned when a timeout or an error occur. [source,erlang] ---- Result :: {inform, Status, Headers} - {response, IsFin, Status, Headers} - {data, IsFin, Data} - {trailers, Trailers} - {push, NewStreamRef, Method, URI, Headers} - {error, Reason} - -Reason :: timeout | any() + | {response, IsFin, Status, Headers} + | {data, IsFin, Data} + | {trailers, Trailers} + | {push, NewStreamRef, Method, URI, Headers} + | {error, Reason} + +Reason :: {stream_error | connection_error | down, any()} + | timeout ---- Because the messages and returned tuples are equivalent, |