path: root/doc/src/manual/cowboy_constraints.asciidoc
blob: 52ee664aae5536440de4cebeb279fa16e15ec55b (plain) (tree)

= cowboy_constraints(3)

== Name

cowboy_constraints - Constraints

== Description

The module `cowboy_constraints` defines the built-in
constraints in Cowboy and provides an interface for
manipulating these constraints.

Constraints are functions that define what type of
input is allowed. They are used throughout Cowboy,
from the router to query strings to cookies.

== Exports

Built-in constraints:

* link:man:cowboy_constraints:int(3)[cowboy_constraints:int(3)] - Integer constraint
* link:man:cowboy_constraints:nonempty(3)[cowboy_constraints:nonempty(3)] - Non-empty constraint

== Types

=== constraint()

constraint() :: int | nonempty | fun()

A constraint function.

The atom constraints are built-in, see the corresponding
function in the exports list above.

=== reason()

reason() :: {constraint(), Reason, Value}

Reason :: any()
Value  :: any()

Reason for the constraint failure.

It includes the constraint function in question,
a machine-readable error reason and the value that
made the constraint fail.

== See also