package dream-httpaf

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

Internal: shared http/af stack for Dream (server) and Hyper (client)

Install

dune-project

Dependency

github.com Edit opam file Versions (4)

Authors

Anton Bachin

Maintainers

Anton Bachin

Sources

dream-1.0.0-alpha6.tar.gz

sha256=8d3b6344c0e175aca628b3d5bb8ee58265e8c1074fc2d40d63f136fef83daf90

doc/dream-httpaf.dream-httpaf_/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.

Sourcemodule Body_length : sig ... end

Source

val body_length : 
  ?proxy:bool ->
  request_method:Method.standard ->
  t ->
  Body_length.t

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