Module Webs.Http

HTTP requests and responses.

HTTP requests, responses, associated types, values, codecs and protocol logic fragments.

References.

Codecs

module Base64 : sig ... end

base64 and base64url codecs.

module Pct : sig ... end

Percent-encoding codec.

module Digits : sig ... end

HTTP digits codec.

Names

HTTP often requires to perform US-ASCII case insensitive comparisons on HTTP tokens. Values of type name represent US-ASCII lowercased HTTP tokens.

type name = private string

The type for lowercased HTTP tokens. In particular header field-names.

module Name : sig ... end

Names.

Versions

type version = int * int

The type for HTTP versions. Both integers must be in the interval [0;9].

module Version : sig ... end

HTTP versions.

Methods

type meth = [
| `GET(*

GET

*)
| `HEAD(*

HEAD

*)
| `POST(*

POST

*)
| `PUT(*

PUT

*)
| `DELETE(*

DELETE

*)
| `CONNECT(*

CONNECT

*)
| `OPTIONS(*

OPTIONS

*)
| `TRACE(*

TRACE

*)
| `PATCH(*

PATCH '

*)
| `Other of string(*

other token

*)
]

The type for HTTP request methods.

module Meth : sig ... end

HTTP request methods

Paths and queries

type fpath = string

The type for file paths.

type path = string list

The type for absolute URI paths represented as non-empty lists of percent-decoded path segments. The empty list denotes the absence of a path.

Path segments can be empty "". The root path / is represented by the list [""] and /a by ["a"], see more examples here.

WARNING. You should never concatenate these segments with a separator to get a file path because they may contain stray percent-decoded directory separators. Use the function Path.to_absolute_filepath to interpret paths as file paths.

module Path : sig ... end

Paths.

type query

The type for queries as key-values maps. Both keys and values are properly decoded. Note that keys can map to multiple values.

module Query : sig ... end

Queries and query codecs.

type headers

The type for HTTP headers. Maps header names to string values such that for:

  • Single valued headers, the value is the string.
  • Multi-valued headers, the values are comma ',' separated as per specification. Use Headers.values_of_string on the string.
  • set_cookie header, must be treated specially since it can be repeated but does not follow the syntax of multi-valued headers. The values are stored in the string separated by '\x00' values. Use Headers.add_set_cookie and Headers.values_of_set_cookie_value to handle the field. On Headers.encode this results in separate set-cookie headers.
module Headers : sig ... end

HTTP headers and values.

Cookies.

Etags and ranges

module Etag : sig ... end

Entity tags.

module Range : sig ... end

Range requests.

Standard header names

val accept : name

accept

val accept_charset : name

accept-charset

val accept_encoding : name

accept-encoding

val accept_language : name

accept-language

val accept_ranges : name

accept-ranges

val age : name

age

val allow : name

allow

val authorization : name

authorization

val cache_control : name

cache-control

val connection : name

connection

val content_encoding : name

content-encoding

val content_language : name

content-language

val content_length : name

content-length

val content_location : name

content-location

val content_range : name

content-range

val content_type : name

content-type

cookie

val date : name

date

val etag : name

etag

val expect : name

expect

val expires : name

expires

val from : name

from

val host : name

host

val if_match : name

if-match

val if_modified_since : name

if-modified-since

val if_none_match : name

if-none-match

val if_range : name

if-range

val if_unmodified_since : name

if-unmodified-since

val last_modified : name

last-modified

val location : name

location

val max_forwards : name

max-forwards

val pragma : name

pragma

val proxy_authenticate : name

proxy-authenticate

val proxy_authorization : name

proxy-authorization

val range : name

range

val referer : name

referer

val retry_after : name

retry-after

val server : name

server

set-cookie

val te : name

te

val trailer : name

trailer

val transfer_encoding : name

transfer-encoding

val upgrade : name

upgrade

val user_agent : name

user-agent

val vary : name

vary

val via : name

via

val warning : name

warning

val www_authenticate : name

www-authenticate

Status codes

type status = int

The type for HTTP status codes.

module Status : sig ... end

Statuses.

Informational 1xx

val continue_100 : status

100

val switching_protocols_101 : status

101

Sucessful 2xx

val ok_200 : status

200

val created_201 : status

201

val accepted_202 : status

202

val non_authoritative_information_203 : status

203

val no_content_204 : status

204

val reset_content_205 : status

205

val partial_content_206 : status

206

Redirection 3xx

val multiple_choices_300 : status

300

val moved_permanently_301 : status

301

val found_302 : status

302

val see_other_303 : status

303

val not_modified_304 : status

304

val use_proxy_305 : status

305

val temporary_redirect_307 : status

307

Client Error 4xx

val bad_request_400 : status

400

val unauthorized_401 : status

401

val payement_required_402 : status

402

val forbidden_403 : status

403

val not_found_404 : status

404

val method_not_allowed_405 : status

405

val not_acceptable_406 : status

406

val proxy_authentication_required_407 : status

407

val request_time_out_408 : status

408

val conflict_409 : status

409

val gone_410 : status

410

val length_required_411 : status

411

val precondition_failed_412 : status

412

val payload_too_large_413 : status

413

val uri_too_long_414 : status

414

val unsupported_media_type_415 : status

415

val range_not_satisfiable_416 : status

416

val expectation_failed_417 : status

417

val i'm_a_teapot_418 : status

418

val upgrade_required_426 : status

436

Server Error 5xx

val server_error_500 : status

500

val not_implemented_501 : status

501

val bad_gateway_502 : status

502

val service_unavailable_503 : status

503

val gateway_time_out_504 : status

504

val http_version_not_supported_505 : status

505

MIME types

type mime_type = string

The type for MIME types.

module Mime_type : sig ... end

MIME type constants and file extensions.

Responses

type resp

The type for HTTP responses.

module Resp : sig ... end

HTTP responses.

Requests

type req

The type for HTTP requests.

module Req : sig ... end

HTTP requests.

Service

type service = req -> resp

The type for services. Maps requests to responses. Note that services should not raise exceptions (but connectors should be prepared to handle spurious ones).

Low-level codecs

Low-level codecs

Warning. This API is unstable and subject to change between minor versions of the library.

module Private : sig ... end