diff options
| author | Loïc Hoguin <[email protected]> | 2014-09-23 16:43:29 +0300 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2014-09-23 16:43:29 +0300 |
| commit | f1c3b6d76f0c97e1ab927c288bb94891ae4c253b (patch) | |
| tree | 5a14c007cdcb487032162b3ca96df648f521321a /doc/src/guide/resp.ezdoc | |
| parent | b57f94661f5fd186f55eb0fead49849e0b1399d1 (diff) | |
| download | cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.gz cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.tar.bz2 cowboy-f1c3b6d76f0c97e1ab927c288bb94891ae4c253b.zip | |
Breaking update of the cowboy_req interface
Simplify the interface for most cowboy_req functions. They all return
a single value except the four body reading functions. The reply functions
now only return a Req value.
Access functions do not return a Req anymore.
Functions that used to cache results do not have a cache anymore.
The interface for accessing query string and cookies has therefore
been changed.
There are now three query string functions: qs/1 provides access
to the raw query string value; parse_qs/1 returns the query string
as a list of key/values; match_qs/2 returns a map containing the
values requested in the second argument, after applying constraints
and default value.
Similarly, there are two cookie functions: parse_cookies/1 and
match_cookies/2. More match functions will be added in future commits.
None of the functions return an error tuple anymore. It either works
or crashes. Cowboy will attempt to provide an appropriate status code
in the response of crashed handlers.
As a result, the content decode function has its return value changed
to a simple binary, and the body reading functions only return on success.
Diffstat (limited to 'doc/src/guide/resp.ezdoc')
| -rw-r--r-- | doc/src/guide/resp.ezdoc | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/src/guide/resp.ezdoc b/doc/src/guide/resp.ezdoc index 28f2544..009756a 100644 --- a/doc/src/guide/resp.ezdoc +++ b/doc/src/guide/resp.ezdoc @@ -16,7 +16,7 @@ Cowboy will make sure to send the mandatory headers with the response. ``` erlang -{ok, Req2} = cowboy_req:reply(200, Req). +Req2 = cowboy_req:reply(200, Req). ``` You can define headers to be sent with the response. Note @@ -24,7 +24,7 @@ that header names must be lowercase. Again, Cowboy will make sure to send the mandatory headers with the response. ``` erlang -{ok, Req2} = cowboy_req:reply(303, [ +Req2 = cowboy_req:reply(303, [ {<<"location">>, <<"http://ninenines.eu">>} ], Req). ``` @@ -35,7 +35,7 @@ by Cowboy. For example, you can advertise yourself as a different server. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"server">>, <<"yaws">>} ], Req). ``` @@ -49,7 +49,7 @@ We recommend that you set the content-type header so the client may know how to read the body. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/plain">>} ], "Hello world!", Req). ``` @@ -57,7 +57,7 @@ client may know how to read the body. Here is the same example but sending HTML this time. ``` erlang -{ok, Req2} = cowboy_req:reply(200, [ +Req2 = cowboy_req:reply(200, [ {<<"content-type">>, <<"text/html">>} ], "<html><head>Hello world!</head><body><p>Hats off!</p></body></html>", Req). ``` @@ -71,10 +71,10 @@ initiate the reply by sending the response status code. Then you can send the body in chunks of arbitrary size. ``` erlang -{ok, Req2} = cowboy_req:chunked_reply(200, Req), -ok = cowboy_req:chunk("Hello...", Req2), -ok = cowboy_req:chunk("chunked...", Req2), -ok = cowboy_req:chunk("world!!", Req2). +Req2 = cowboy_req:chunked_reply(200, Req), +cowboy_req:chunk("Hello...", Req2), +cowboy_req:chunk("chunked...", Req2), +cowboy_req:chunk("world!!", Req2). ``` You should make sure to match on `ok` as an error may be @@ -85,11 +85,11 @@ a content-type header, it is still recommended. You can set this header or any other just like for normal replies. ``` erlang -{ok, Req2} = cowboy_req:chunked_reply(200, [ +Req2 = cowboy_req:chunked_reply(200, [ {<<"content-type">>, <<"text/html">>} ], Req), -ok = cowboy_req:chunk("<html><head>Hello world!</head>", Req2), -ok = cowboy_req:chunk("<body><p>Hats off!</p></body></html>", Req2). +cowboy_req:chunk("<html><head>Hello world!</head>", Req2), +cowboy_req:chunk("<body><p>Hats off!</p></body></html>", Req2). ``` Note that the reply and each chunk following it are sent |