Module Http.Resp

The type for direct response connection. This is connector dependent.

The type for response consumers.

Services call consumers with Some (byte, first len) to output the corresponding data and None when they are finished.

Response consumers are provided by the connector to pull the body produced by a response. If you are writing a consumer, the bytes MUST NOT be modified by the consumer and only read from first to first+len.

The type for response bodies. This is either:

• An empty body.
• A stream to which a consumer will be passed by the connector.
• A direct connection handler, the connector will pass it's connection representation.

empty_body s is an empty body.

stream_body producer is a response body stream produced by producer on the consumer it will be given to.

direct_body producer is a response body produced by producer on the given (backend specific) connection.

body_of_string s is a reponse body made of string s.

pp_body ppf b prints an unspecified representation of b's specification on ppf but guarantees not to consume the body.

The type for responses.

v status headers body is a response with given status, headers (defaults to Http.Headers.empty), body (defaults to empty_body, reason (defaults to Http.status_reason_phrase) and version (defaults to (1,1)), explain is a server side reason it is not put on the wire.

FIXME. Maybe make body non-optional to encourage use of empty which is clearer in code.

Note. If body is body_empty (default) a Http.content_length of 0 is automatically added to headers.

version r is r's version.

status r is r's status.

reason r is r's reason phrase.

headers r is r's headers.

body r is r's body.

explain r is r's explanation. In contrast to reason this remains on the server and can be, for example logged.

with_status st r is r with status st and reason phrase reason (defaults to Http.status_reason_phrase.

with_headers hs r is r with headers hs.

override_headers by r is r with headers H.override (headers r) ~by.

with_body b r is r with body b.

pp ppf t prints an unspecified representation of r on ppf but guarantees not to consume the body.

result r is Result.fold ~ok:Fun.id ~error:Fun.id.

empty ?explain ?reason ?headers st is v ?explain ?reason ?headers st.

content ~mime_type st s responds s with content type mime_type and status st. Sets Http.content_type and Http.content_length appropriately.

text responds with UTF-8 encoded plain text, i.e. content with Http.Mime_type.text_plain.

html responds with UTF-8 encoded HTML text, i.e. content with Http.Mime_type.text_html.

json responds with JSON text, i.e. content with Http.Mime_type.application_json.

octets responds with octets, i.e. content with Http.Mime_type.application_octet_stream.

redirect status loc redirects to location loc with status status (defaults to Http.found_302). See also Req.service_redirect.

bad_request ?explain ?reason () is an empty response with status Http.bad_request_400.

unauthorized ?explain ?reason () is an empty response with status Http.unauthorized_401.

forbidden ?explain ?reason is an empty response with status Http.forbidden_403.

not_found ?explain ?reason is an empty response with status Http.not_found_404.

method_not_allowed ~allowed is an empty response with status Http.method_not_allowed_405. It sets the Http.allow header to the allowed methods (which can be empty).

not_found ?explain ?reason is an empty response with status Http.gone_410.

server_error ?explain ?reason is an empty response with status Http.server_error_500.

server_error ?explain ?reason is an empty response with status Http.not_implemented_501.

map_errors ~only_empty f r maps r with f if r's status is a 4XX or 5XX. If only_empty is true (defaults to false) it does so only on empty body responses.