View Source Orbit.Status (Orbit v0.1.0)

The canonical list of response status codes.

This module contains helper functions for applying any status code to an Orbit.Request.

When set manually, status codes may be specified by integer or atom. They can be coerced one way or the other with to_atom/1 and to_integer/1.

Status	Name
10	`:input`
11	`:sensitive_input`
20	`:success`
30	`:redirect_temporary`
31	`:redirect_permanent`
40	`:temporary_failure`
41	`:server_unavailable`
42	`:cgi_error`
43	`:proxy_error`
44	`:slow_down`
50	`:permanent_failure`
51	`:not_found`
52	`:gone`
53	`:proxy_request_refused`
59	`:bad_request`
60	`:client_certificate_required`
61	`:certificate_not_authorized`
62	`:certificate_not_valid`

Link to this section Summary

Types

t()

Functions

bad_request(req, meta \\ nil)

Responds with the :bad_request (59) status.

certificate_not_authorized(req, meta \\ nil)

Responds with the :certificate_not_authorized (61) status.

certificate_not_valid(req, meta \\ nil)

Responds with the :certificate_not_valid (62) status.

cgi_error(req, meta \\ nil)

Responds with the :cgi_error (42) status.

client_certificate_required(req, meta \\ nil)

Responds with the :client_certificate_required (60) status.

gone(req, meta \\ nil)

Responds with the :gone (52) status.

input(req, meta \\ nil)

Responds with the :input (10) status.

not_found(req, meta \\ nil)

Responds with the :not_found (51) status.

permanent_failure(req, meta \\ nil)

Responds with the :permanent_failure (50) status.

proxy_error(req, meta \\ nil)

Responds with the :proxy_error (43) status.

proxy_request_refused(req, meta \\ nil)

Responds with the :proxy_request_refused (53) status.

redirect_permanent(req, meta \\ nil)

Responds with the :redirect_permanent (31) status.

redirect_temporary(req, meta \\ nil)

Responds with the :redirect_temporary (30) status.

sensitive_input(req, meta \\ nil)

Responds with the :sensitive_input (11) status.

server_unavailable(req, meta \\ nil)

Responds with the :server_unavailable (41) status.

slow_down(req, meta \\ nil)

Responds with the :slow_down (44) status.

success(req, body, mime_type \\ nil)

Responds with a success status containing body content.

temporary_failure(req, meta \\ nil)

Responds with the :temporary_failure (40) status.

to_atom(status)

Normalizes a status code to an atom.

to_integer(status)

Normalizes a status code to an integer.

Link to this section Types

t()

@type t() :: atom() | non_neg_integer()

Link to this section Functions

bad_request(req, meta \\ nil)

Responds with the :bad_request (59) status.

certificate_not_authorized(req, meta \\ nil)

Responds with the :certificate_not_authorized (61) status.

certificate_not_valid(req, meta \\ nil)

Responds with the :certificate_not_valid (62) status.

cgi_error(req, meta \\ nil)

Responds with the :cgi_error (42) status.

client_certificate_required(req, meta \\ nil)

Responds with the :client_certificate_required (60) status.

gone(req, meta \\ nil)

Responds with the :gone (52) status.

input(req, meta \\ nil)

Responds with the :input (10) status.

not_found(req, meta \\ nil)

Responds with the :not_found (51) status.

permanent_failure(req, meta \\ nil)

Responds with the :permanent_failure (50) status.

proxy_error(req, meta \\ nil)

Responds with the :proxy_error (43) status.

proxy_request_refused(req, meta \\ nil)

Responds with the :proxy_request_refused (53) status.

redirect_permanent(req, meta \\ nil)

Responds with the :redirect_permanent (31) status.

redirect_temporary(req, meta \\ nil)

Responds with the :redirect_temporary (30) status.

sensitive_input(req, meta \\ nil)

Responds with the :sensitive_input (11) status.

server_unavailable(req, meta \\ nil)

Responds with the :server_unavailable (41) status.

slow_down(req, meta \\ nil)

Responds with the :slow_down (44) status.

success(req, body, mime_type \\ nil)

Responds with a success status containing body content.

temporary_failure(req, meta \\ nil)

Responds with the :temporary_failure (40) status.

to_atom(status)

Normalizes a status code to an atom.

to_integer(status)

Normalizes a status code to an integer.