path: root/doc/src/manual/cowboy_constraints.int.asciidoc
blob: 28855a48023d5ca076f7f35059b10f964f62cb72 (plain) (tree)

= cowboy_constraints:int(3)

== Name

cowboy_constraints:int - Integer constraint

== Description

Constraint functions implement a number of different operations.

int(forward, Bin) -> {ok, Int} | {error, not_an_integer}

Bin :: binary()
Int :: integer()

Validate and convert the text representation of an integer.

int(reverse, Int) -> {ok, Bin} | {error, not_an_integer}

Convert an integer back to its text representation.

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