diff options
| author | Loïc Hoguin <essen@ninenines.eu> | 2017-09-04 14:33:44 +0200 |
|---|---|---|
| committer | Loïc Hoguin <essen@ninenines.eu> | 2017-09-04 14:33:44 +0200 |
| commit | 58e9e76814a8291894ba01ac8a4551e4f8d480b3 (patch) | |
| tree | 58145af48e5c9dbcec51ffec14bb9faea25c6b24 /doc/src/manual/cowboy_constraints.int.asciidoc | |
| parent | 47aa0097ed3f63bf0de1b540a6a8d4086e3d2ea6 (diff) | |
| download | cowboy-58e9e76814a8291894ba01ac8a4551e4f8d480b3.tar.gz cowboy-58e9e76814a8291894ba01ac8a4551e4f8d480b3.tar.bz2 cowboy-58e9e76814a8291894ba01ac8a4551e4f8d480b3.zip | |
Fix more documentation todos
I have decided not to include a manual page for
cowboy_stream_h at this point because it clashes
with the cowboy_stream manual page. This decision
will be revisited in the future.
Diffstat (limited to 'doc/src/manual/cowboy_constraints.int.asciidoc')
| -rw-r--r-- | doc/src/manual/cowboy_constraints.int.asciidoc | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_constraints.int.asciidoc b/doc/src/manual/cowboy_constraints.int.asciidoc new file mode 100644 index 0000000..28855a4 --- /dev/null +++ b/doc/src/manual/cowboy_constraints.int.asciidoc @@ -0,0 +1,63 @@ += cowboy_constraints:int(3) + +== Name + +cowboy_constraints:int - Integer constraint + +== Description + +Constraint functions implement a number of different operations. + +[source,erlang] +---- +int(forward, Bin) -> {ok, Int} | {error, not_an_integer} + +Bin :: binary() +Int :: integer() +---- + +Validate and convert the text representation of an integer. + +[source,erlang] +---- +int(reverse, Int) -> {ok, Bin} | {error, not_an_integer} +---- + +Convert an integer back to its text representation. + +[source,erlang] +---- +int(format_error, Error) -> HumanReadable + +Error :: {not_an_integer, Bin | Int} +HumanReadable :: iolist() +---- + +Generate a human-readable error message. + +== Arguments + +Arguments vary depending on the operation. Constraint +functions always take the operation type as first argument, +and the value as second argument. + +== Return value + +The return value varies depending on the operation. + +== Changelog + +* *2.0*: Interface modified to allow for a variety of operations. +* *1.0*: Constraint introduced. + +== Examples + +This function is not meant to be called directly. + +== See also + +link:man:cowboy_constraints(3)[cowboy_constraints(3)], +link:man:cowboy_constraints:nonempty(3)[cowboy_constraints:nonempty(3)], +link:man:cowboy_router(3)[cowboy_router(3)], +link:man:cowboy_req:match_cookies(3)[cowboy_req:match_cookies(3)], +link:man:cowboy_req:match_qs(3)[cowboy_req:match_qs(3)] |