From 7a274661b297375c8c2c0c1d9cd23bb52185cf84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 28 Dec 2013 20:10:06 +0100 Subject: Fix typespecs for cowboy_req:binding/{2,3} and :bindings/1 --- manual/cowboy_req.md | 12 ++++++++++-- src/cowboy_req.erl | 6 +++--- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/manual/cowboy_req.md b/manual/cowboy_req.md index c7e2180..d7af41f 100644 --- a/manual/cowboy_req.md +++ b/manual/cowboy_req.md @@ -49,17 +49,25 @@ Request related exports > Types: > * Name = atom() > * Default = any() -> * Value = binary() | Default +> * Value = any() | Default > > Return the value for the given binding. +> +> By default the value is a binary, however constraints may change +> the type of this value (for example automatically converting +> numbers to integer). ### bindings(Req) -> {[{Name, Value}], Req2} > Types: > * Name = atom() -> * Value = binary() +> * Value = any() > > Return all bindings. +> +> By default the value is a binary, however constraints may change +> the type of this value (for example automatically converting +> numbers to integer). ### cookie(Name, Req) -> cookie(Name, Req, undefined) ### cookie(Name, Req, Default) -> {Value, Req2} diff --git a/src/cowboy_req.erl b/src/cowboy_req.erl index 5d12304..d98e395 100644 --- a/src/cowboy_req.erl +++ b/src/cowboy_req.erl @@ -334,14 +334,14 @@ url(HostURL, Req=#http_req{path=Path, qs=QS}) -> {<< HostURL/binary, Path/binary, QS2/binary >>, Req}. %% @equiv binding(Name, Req, undefined) --spec binding(atom(), Req) -> {binary() | undefined, Req} when Req::req(). +-spec binding(atom(), Req) -> {any() | undefined, Req} when Req::req(). binding(Name, Req) when is_atom(Name) -> binding(Name, Req, undefined). %% @doc Return the binding value for the given key obtained when matching %% the host and path against the dispatch list, or a default if missing. -spec binding(atom(), Req, Default) - -> {binary() | Default, Req} when Req::req(), Default::any(). + -> {any() | Default, Req} when Req::req(), Default::any(). binding(Name, Req, Default) when is_atom(Name) -> case lists:keyfind(Name, 1, Req#http_req.bindings) of {Name, Value} -> {Value, Req}; @@ -349,7 +349,7 @@ binding(Name, Req, Default) when is_atom(Name) -> end. %% @doc Return the full list of binding values. --spec bindings(Req) -> {list({atom(), binary()}), Req} when Req::req(). +-spec bindings(Req) -> {[{atom(), any()}], Req} when Req::req(). bindings(Req) -> {Req#http_req.bindings, Req}. -- cgit v1.2.3