package http

  1. Overview
  2. Docs
Type definitions of HTTP essentials

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (6)

Authors

  1. A
    Anil Madhavapeddy
  2. S
    Stefano Zacchiroli
  3. D
    David Sheets
  4. T
    Thomas Gazagnaire
  5. D
    David Scott
  6. R
    Rudi Grinberg
  7. A
    Andy Ray
  8. A
    Anurag Soni

Maintainers

  1. A
    Anil Madhavapeddy <anil@recoil.org>

Sources

cohttp-6.1.1.tbz
sha256=6b420c56203b3a0b515964f036bcea0fb9a362876b5791cd7ff50e12366c489c
sha512=839ff6156658ca6d7922e6eed63ebb84dd09c76107790477be55a1ffc4a3800bf49c435147a0ed628f147eaeccff9a8d34565e3787f32c15e187b6e8855f0b93

doc/http/Http/Response/index.html

Module Http.ResponseSource

Sourcetype t = {
  1. headers : Header.t;
    (*

    response HTTP headers

    *)
  2. version : Version.t;
    (*

    (** HTTP version, usually 1.1 *)

    *)
  3. status : Status.t;
    (*

    HTTP status code of the response

    *)
}
Sourceval headers : t -> Header.t
Sourceval version : t -> Version.t
Sourceval status : t -> Status.t
Sourceval compare : t -> t -> int
Sourceval is_keep_alive : t -> bool

Return true whether the connection should be reused

Sourceval requires_content_length : ?request_meth:Method.t -> t -> bool

requires_content_length ~request_meth t is true if a combination of t and request_meth indicates that a response message must include "Content-Length" header. However, please note exceptions to this:

  • Response with status code of 304 may or may not include the header.
  • Response to request with method HEAD may or may not include the header.

https://www.rfc-editor.org/rfc/rfc7230#section-3.3.2

Sourceval content_length : t -> int option

content_length t is Some x if the "Content-Length" header in t exists and its value x is a non negative integer, x>=0

It is None if requires_content_length t = false or the value encoded in "Content-Length" is not a valid integer value, i.e >= 0.

See https://www.rfc-editor.org/rfc/rfc7230#section-3.3.2

Sourceval make : ?version:Version.t -> ?status:Status.t -> ?headers:Header.t -> unit -> t

make () is a value of t. The default values for the request, if not specified, are: status is `Ok, version is `HTTP_1_1. The request encoding value is determined via the Header.get_transfer_encoding function.

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