package dream

You can search for identifiers within the package.

in-package search v0.2.0

Tidy, feature-complete Web framework

Install

dune-project

Dependency

github.com Readme MIT License Edit opam file Versions (8)

Authors

Anton Bachin

Maintainers

Anton Bachin

Sources

dream-1.0.0-alpha2.tar.gz

sha256=bf19c13f0da7e01cc30b8dfaa1fca1dc8b44a06fb6e0eef56d56513952b9bb01

md5=1220f17530522e488653eb91115867e3

doc/dream.httpaf/Httpaf/Response/index.html

Module `Httpaf.Response`Source

Response

A server-generated message to a

equest

.

Sourcetype t = {

version : Version.t;
status : Status.t;
reason : string;
headers : Headers.t;

}

Source

val create : 
  ?reason:string ->
  ?version:Version.t ->
  ?headers:Headers.t ->
  Status.t ->
  t

create ?reason ?version ?headers status creates an HTTP response with the given parameters. For typical use cases, it's sufficient to provide values for headers and status.

Source

val body_length : 
  ?proxy:bool ->
  request_method:Method.standard ->
  t ->
  [ `Fixed of Int64.t
  | `Chunked
  | `Close_delimited
  | `Error of [ `Bad_gateway | `Internal_server_error ] ]

body_length ?proxy ~request_method t is the length of the message body accompanying t assuming it is a response to a request whose method was request_method. If the calling code is acting as a proxy, it should pass ~proxy:true. This optional parameter only affects error reporting.

See RFC7230§3.3.3 for more details.

Sourceval persistent_connection : ?proxy:bool -> t -> bool

persistent_connection ?proxy t indicates whether the connection for t can be reused for multiple requests and responses. If the calling code is acting as a proxy, it should pass ~proxy:true.

See RFC7230§6.3 for more details.

Sourceval pp_hum : Format.formatter -> t -> unit