Module backwater_response

Data Types
Function Index
Function Details

Data Types

error()

error() = {exception, {Class::error | exit | throw, Reason::term(), [backwater:stack_item()]}} | {failure(), raw_response()}

failure()

failure() = {response_authentication, response_authentication_failure()} | response_decode_failure() | remote

headers()

headers() = [{nonempty_binary(), binary()}]

options()

options() = #{decode_unsafe_terms => boolean(), max_encoded_result_size => non_neg_integer(), rethrow_remote_exceptions => boolean()}

raw_response()

raw_response() = {status_code_name(), CiHeaders::headers(), RawBody::binary()}

response_authentication_failure()

response_authentication_failure() = backwater_signatures:response_validation_failure() | wrong_body_digest

response_decode_failure()

response_decode_failure() = invalid_content_encoding | invalid_content_type | invalid_body

status_code()

status_code() = pos_integer()

status_code_name()

status_code_name() = ok | bad_request | unauthorized | forbidden | not_found | not_acceptable | payload_too_large | unsupported_media_type | internal_error | {http, status_code()}

t()

t(OtherError) = {ok, Value::term()} | {error, error() | OtherError} | no_return()

t()

t() = {ok, Value::term()} | {error, error()} | no_return()

Function Index

decode/4
decode/5

Function Details

decode/4

decode(StatusCode, Headers, Body, RequestState) -> Response | no_return()

StatusCode = status_code()
Headers = headers()
Body = binary()
RequestState = backwater_request:state()
Response = t()

decode/5

decode(StatusCode, Headers, Body, RequestState, Options) -> Response | no_return()

StatusCode = status_code()
Headers = headers()
Body = binary()
RequestState = backwater_request:state()
Options = options()
Response = t()

Generated by EDoc