raxx v0.10.1 Raxx.Response

HTTP responses from a Raxx application are encapsulated in a Raxx.Response struct.

The contents are itemised below:

status	The HTTP status code for the response: `1xx, 2xx, 3xx, 4xx, 5xx`
headers	The response headers as a map: `%{"content-type" => ["text/plain"]}`
body	The response body, by default an empty string.

Examples

iex> Response.ok().status
200

iex> Response.ok("Hello, World!").body
"Hello, World!"

iex> Response.ok([{"content-language", "en"}]).headers
[{"content-language", "en"}]

iex> Response.ok("Hello, World!", [{"content-type", "text/plain"}]).headers
[{"content-type", "text/plain"}]

Summary

Functions

accepted(body \\ "", headers \\ [])

Create a “202 Accepted” response

bad_gateway(body \\ "", headers \\ [])

Create a “502 Bad Gateway” response

bad_request(body \\ "", headers \\ [])

Create a “400 Bad Request” response

client_error?(map)

The response indicates that the client sent an incorrect request

conflict(body \\ "", headers \\ [])

Create a “409 Conflict” response

continue(body \\ "", headers \\ [])

Create a “100 Continue” response

created(body \\ "", headers \\ [])

Create a “201 Created” response

expectation_failed(body \\ "", headers \\ [])

Create a “417 Expectation Failed” response

forbidden(body \\ "", headers \\ [])

Create a “403 Forbidden” response

found(body \\ "", headers \\ [])

Create a “302 Found” response

gateway_timeout(body \\ "", headers \\ [])

Create a “504 Gateway Timeout” response

gone(body \\ "", headers \\ [])

Create a “410 Gone” response

http_version_not_supported(body \\ "", headers \\ [])

Create a “505 HTTP Version Not Supported” response

informational?(map)

The response is marked as an interim response

internal_server_error(body \\ "", headers \\ [])

Create a “500 Internal Server Error” response

length_required(body \\ "", headers \\ [])

Create a “411 Length Required” response

method_not_allowed(body \\ "", headers \\ [])

Create a “405 Method Not Allowed” response

moved_permanently(body \\ "", headers \\ [])

Create a “301 Moved Permanently” response

multiple_choices(body \\ "", headers \\ [])

Create a “300 Multiple Choices” response

no_content(body \\ "", headers \\ [])

Create a “204 No Content” response

non-authoritative_information(body \\ "", headers \\ [])

Create a “203 Non-Authoritative Information” response

not_acceptable(body \\ "", headers \\ [])

Create a “406 Not Acceptable” response

not_found(body \\ "", headers \\ [])

Create a “404 Not Found” response

not_implemented(body \\ "", headers \\ [])

Create a “501 Not Implemented” response

not_modified(body \\ "", headers \\ [])

Create a “304 Not Modified” response

ok(body \\ "", headers \\ [])

Create a “200 OK” response

partial_content(body \\ "", headers \\ [])

Create a “206 Partial Content” response

payload_too_large(body \\ "", headers \\ [])

Create a “413 Payload Too Large” response

payment_required(body \\ "", headers \\ [])

Create a “402 Payment Required” response

precondition_failed(body \\ "", headers \\ [])

Create a “412 Precondition Failed” response

proxy_authentication_required(body \\ "", headers \\ [])

Create a “407 Proxy Authentication Required” response

range_not_satisfiable(body \\ "", headers \\ [])

Create a “416 Range Not Satisfiable” response

redirect?(map)

The response indicates that further action needs to be taken by the client

request_timeout(body \\ "", headers \\ [])

Create a “408 Request Timeout” response

reset_content(body \\ "", headers \\ [])

Create a “205 Reset Content” response

see_other(body \\ "", headers \\ [])

Create a “303 See Other” response

server_error?(map)

The response indicates that the server is incapable of acting upon the request

service_unavailable(body \\ "", headers \\ [])

Create a “503 Service Unavailable” response

success?(map)

The response indicates that client request was received, understood, and accepted

switching_protocols(body \\ "", headers \\ [])

Create a “101 Switching Protocols” response

temporary_redirect(body \\ "", headers \\ [])

Create a “307 Temporary Redirect” response

unauthorized(body \\ "", headers \\ [])

Create a “401 Unauthorized” response

unsupported_media_type(body \\ "", headers \\ [])

Create a “415 Unsupported Media Type” response

upgrade_required(body \\ "", headers \\ [])

Create a “426 Upgrade Required” response

uri_too_long(body \\ "", headers \\ [])

Create a “414 URI Too Long” response

use_proxy(body \\ "", headers \\ [])

Create a “305 Use Proxy” response

Functions

accepted(body \\ "", headers \\ [])

Create a “202 Accepted” response.