Associative list representing HTTP headers. Order of transmission is preserved, which implies that headers with same name are neither removed or concataned by default (see clean_dup to do that).
The type for HTTP headers.
include module type of Http.Header with type t = Http.Header.ttype t = Http.Header.tAssociative list representing HTTP headers. Order of transmission is preserved, which implies that headers with same name are neither removed or concataned by default (see clean_dup to do that).
The type for HTTP headers.
val iter_ord : (string -> string -> unit) -> t -> unititer_ord f h applies f to all the headers of h following the header order.
module Private : sig ... endval sexp_of_t : t -> Sexplib0.Sexp.tval t_of_sexp : Sexplib0.Sexp.t -> tval init : unit -> tinit () constructs a fresh, empty list of HTTP headers.
val is_empty : t -> boolis_empty h tests whether HTTP headers h are empty or not.
val of_list_rev : (string * string) list -> tval of_list : (string * string) list -> tof_list l construct a fresh headers from the content of l and in same order. to_list and of_list are defined such as to_list (of_list l) = l is true with case insensitive comparison.
val to_list : t -> (string * string) listto_list h converts HTTP headers h to a list. Order and case is preserved.
Invariant (with case insensitive comparison): to_list (of_list l) = l
val init_with : string -> string -> tinit_with k v construct a fresh HTTP headers with a single header with name k and value v.
add h k v adds the header name k and it associated value v at the end of header list h.
add_list h l adds in order all header pairs contained in l to the header list h.
Invariant (with case insensitive comparison): to_list (add_list h l) = to_list h @ l
add_multi h k vs add multiple header pairs with same name h and values contained in vs in h. The new headers are in the same order that in vs.
Invariant: get_multi (add_multi h k vs) k = (get_multi h k) @ vs
add_opt hopt k v adds the header (k, v) to h if hopt is Some h, or constructs a fresh header list containing this single header if hopt is None.
add_unless_exists h k v adds (k, v) to h unless the header name k is already present in the header.
add_opt_unless_exists h k v adds (k, v) to h if hopt is Some h unless the header name k is already present in the headers. If h is None then a fresh header list is constructed containing the header (k, v).
remove h k removes every values associated to the header name k from h.
replace h k v replaces the last added value of k from h and removed all other occurrences of k if it exists. Otherwise it adds (k, v) to h.
Invariant: forall h, k, v. get_multi (replace h k v) = [ v ]
val mem : t -> string -> boolmem h k returns true if the header name k appears in h and false otherwise.
val get : t -> string -> string optionget h k returns Some v where v is the last added value associated with k in h if it exists and None otherwise
val get_multi : t -> string -> string listget_multi h k returns a list of all values associated with k in h in order they appear in it.
val get_multi_concat : ?list_value_only:bool -> t -> string -> string optionget_multi_concat h k returns Some v if there is at least one value associated with k in h and None otherwise. v is the concatenation of all values paired with k in h, separated by a comma and in order they appear in h.
The optional argument ?list_value_only is false by default. If it is true and there is at least one value associated to k, the returned value is the concatenated values only if k is a header that can have multiple values (like transfer-encoding or accept). Otherwise, the returned value is the last value paired with k in h.
Invariant: forall h, k not a list-value header. get_multi_concat ~list-value-only:true h k = get h k
update h k f returns an header list containing the same headers as h, except for the header name k. Depending on the value of v where v is f (get h k), the header pair (k, v) is added, removed or updated.
v is None, the last occurrence of k in h is removed;v is Some w then the last value paired with k in h is replaced by w if it exists. Otherwise, the pair (k, w) is added;k was already associated last in h to a value that is physically equal to w, h is returned unchanged.update_all h k f returns an header list containing the same headers as h, except for the header k. Depending on the list of values vs where vs is f (get_multi h k), the values associated to the header k are added, removed or updated.
vs is an empty list, every occurrences of the header k in h are removed;vs is a non-empty list, all values previously associated to k are removed and all values in vs are added with add_multi;k was already associated in h to a list that is equal to vs, h is returned unchanged.val iter : (string -> string -> unit) -> t -> unitval fold : (string -> string -> 'a -> 'a) -> t -> 'a -> 'aval to_lines : t -> string listto_lines h returns header fields as a list of lines. Beware that each line ends with "\r\n" characters.
val to_frames : t -> string listto_frames h returns the same as to_lines but lines do not end with "\r\n" characters.
val to_string : t -> stringclean_dup h cleans duplicates in h following RFC7230§3.2.2; if a duplicated header can not have multiple values, only the last value is kept in place. Otherwise, the values are concatenated and place at the first position the header is encountered in h.
Already concatenated values (like anhost.com, anotherhost.com in the example below) are not affected by clean_dup. For example,
transfer-encoding: gzip
host: afirsthost.com
connection: keep-alive
host: anhost.com, anotherhost.com
transfer-encoding: chunkedbecomes
transfer-encoding: gzip, chunked
connection: keep-alive
host: anhost.com, anotherhost.comFinally, following RFC7230§3.2.2, the header Set-cookie is treated as an exception and ignored by clean_dup.
val get_media_type : t -> string optionval get_connection_close : t -> boolval get_acceptable_media_ranges :
t ->
(Accept.media_range * Accept.p list) Accept.qlistval get_acceptable_charsets : t -> Accept.charset Accept.qlistval get_acceptable_encodings : t -> Accept.encoding Accept.qlistval get_acceptable_languages : t -> Accept.language Accept.qlistval get_transfer_encoding : t -> Transfer.encodingval add_transfer_encoding : t -> Transfer.encoding -> tval add_authorization : t -> Auth.credential -> tval get_authorization : t -> Auth.credential optionval add_authorization_req : t -> Auth.challenge -> tval is_form : t -> boolPrepend user_agent to the product token already declared in the "User-Agent" field (if any).
val connection : t -> [ `Keep_alive | `Close | `Unknown of string ] optionval pp_hum : Format.formatter -> t -> unitHuman-readable output, used by the toplevel printer