path: root/ROADMAP.md
diff options
authorLoïc Hoguin <[email protected]>2014-09-23 16:43:29 +0300
committerLoïc Hoguin <[email protected]>2014-09-23 16:43:29 +0300
commitf1c3b6d76f0c97e1ab927c288bb94891ae4c253b (patch)
tree5a14c007cdcb487032162b3ca96df648f521321a /ROADMAP.md
parentb57f94661f5fd186f55eb0fead49849e0b1399d1 (diff)
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 'ROADMAP.md')
1 files changed, 0 insertions, 32 deletions
diff --git a/ROADMAP.md b/ROADMAP.md
index db94461..5a2f95c 100644
--- a/ROADMAP.md
+++ b/ROADMAP.md
@@ -20,38 +20,6 @@ A number of backward incompatible changes are planned. These
changes are individually small, but together should result
in a large improvement in usability.
-### cowboy_req
-The interface of `cowboy_req` will be largely changed. The
-number one complaint about Cowboy today is that you have
-to keep track of the Req whenever you do anything. The new
-interface will minimize that.
-All functions will return a single term, excluding the body
-reading functions `body/{1,2}`, `body_qs/{1,2}`, `part/{1,2}`,
-Of the functions returning a single term, some of them will
-return a Req object. This includes the functions that already
-return Req: `compact/1`, `delete_resp_header/2`, `set_meta/3`,
-`set_resp_body/2`, `set_resp_body_fun/{2,3}`, `set_resp_cookie/4`,
-`set_resp_header/3`, and adds the `chunked_reply/{2,3}` and
-`reply/{2,3,4}` functions to the list.
-Of note is that this will allow chaining all the response
-functions if that's what you fancy.
-The `parse_header/{2,3}` function will now only return the
-parsed header value, and crash on error. It will also not
-cache the parsed value anymore, except for headers that Cowboy
-requires, like the connection header.
-It is unsure what will become of the `qs_val`, `qs_vals`,
-`cookie` and `cookies` functions. The main idea at this point
-is to replace them with a `parse_qs/2` and `parse_cookies/2`
-that would return the parsed list, and let the user decide
-how to access it.
### init/terminate unification
The first argument of the `init/3` function is too rarely used.