From 5f9ed7962fc54d0c6a33464be306259e082c096e Mon Sep 17 00:00:00 2001 From: c-cube Date: Tue, 8 Aug 2023 16:41:52 +0000 Subject: [PATCH] deploy: 1b7939c17a03c4f8388d6030070fc5a38ab3c009 --- dev/tiny_httpd/Tiny_httpd/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_atomic_/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_buf/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_dir/Embedded_fs/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_dir/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_dir/module-type-VFS/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_html/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_html_/A/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_html_/Out/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_html_/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_io/In_channel/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_io/Out_channel/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_io/TCP_server/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_io/Writer/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_io/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_pool/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Headers/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Meth/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Middleware/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Request/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Response/index.html | 6 +++++- dev/tiny_httpd/Tiny_httpd_server/Response_code/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/Route/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_server/index.html | 2 +- .../Tiny_httpd_server/module-type-IO_BACKEND/index.html | 2 +- .../module-type-SERVER_SENT_GENERATOR/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_stream/index.html | 2 +- dev/tiny_httpd/Tiny_httpd_util/index.html | 2 +- dev/tiny_httpd/index.html | 2 +- dev/tiny_httpd_camlzip/Tiny_httpd_camlzip/index.html | 2 +- dev/tiny_httpd_camlzip/index.html | 2 +- dev/tiny_httpd_eio/Tiny_httpd_eio/index.html | 2 +- dev/tiny_httpd_eio/index.html | 2 +- 33 files changed, 37 insertions(+), 33 deletions(-) diff --git a/dev/tiny_httpd/Tiny_httpd/index.html b/dev/tiny_httpd/Tiny_httpd/index.html index b75295d4..867da8e8 100644 --- a/dev/tiny_httpd/Tiny_httpd/index.html +++ b/dev/tiny_httpd/Tiny_httpd/index.html @@ -1,5 +1,5 @@ -Tiny_httpd (tiny_httpd.Tiny_httpd)

Module Tiny_httpd

Tiny Http Server

This library implements a very simple, basic HTTP/1.1 server using blocking IOs and threads. Basic routing based on Scanf is provided for convenience, so that several handlers can be registered.

It is possible to use a thread pool, see create's argument new_thread.

The echo example (see src/examples/echo.ml) demonstrates some of the features by declaring a few endpoints, including one for uploading files:

module S = Tiny_httpd
+Tiny_httpd (tiny_httpd.Tiny_httpd)
Module Tiny_httpd
Tiny Http Server
This library implements a very simple, basic HTTP/1.1 server using blocking IOs and threads. Basic routing based on Scanf is provided for convenience, so that several handlers can be registered.
It is possible to use a thread pool, see create's argument new_thread.
The echo example (see src/examples/echo.ml) demonstrates some of the features by declaring a few endpoints, including one for uploading files:
module S = Tiny_httpd
 
 let () =
   let server = S.create () in
diff --git a/dev/tiny_httpd/Tiny_httpd_atomic_/index.html b/dev/tiny_httpd/Tiny_httpd_atomic_/index.html
index 63f6c2dd..3187d9b4 100644
--- a/dev/tiny_httpd/Tiny_httpd_atomic_/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_atomic_/index.html
@@ -1,2 +1,2 @@
 
-Tiny_httpd_atomic_ (tiny_httpd.Tiny_httpd_atomic_)
Module Tiny_httpd_atomic_
include module type of struct include Stdlib.Atomic end
type !'a t = 'a Stdlib__Atomic.t
val make : 'a -> 'a t
val get : 'a t -> 'a
val set : 'a t -> 'a -> unit
val exchange : 'a t -> 'a -> 'a
val compare_and_set : 'a t -> 'a -> 'a -> bool
val fetch_and_add : int t -> int -> int
val incr : int t -> unit
val decr : int t -> unit

\ No newline at end of file
+Tiny_httpd_atomic_ (tiny_httpd.Tiny_httpd_atomic_)
Module Tiny_httpd_atomic_
include module type of struct include Stdlib.Atomic end
type !'a t = 'a Stdlib__Atomic.t
val make : 'a -> 'a t
val get : 'a t -> 'a
val set : 'a t -> 'a -> unit
val exchange : 'a t -> 'a -> 'a
val compare_and_set : 'a t -> 'a -> 'a -> bool
val fetch_and_add : int t -> int -> int
val incr : int t -> unit
val decr : int t -> unit

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_buf/index.html b/dev/tiny_httpd/Tiny_httpd_buf/index.html
index 3f18c8a9..85abc1d2 100644
--- a/dev/tiny_httpd/Tiny_httpd_buf/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_buf/index.html
@@ -1,2 +1,2 @@
 
-Tiny_httpd_buf (tiny_httpd.Tiny_httpd_buf)
Module Tiny_httpd_buf
Simple buffer.
These buffers are used to avoid allocating too many byte arrays when processing streams and parsing requests.
  • since 0.12
type t
val size : t -> int
val clear : t -> unit
val create : ?size:int -> unit -> t
val contents : t -> string
val bytes_slice : t -> bytes
Access underlying slice of bytes.
  • since 0.5
val contents_and_clear : t -> string
Get contents of the buffer and clear it.
  • since 0.5
val add_char : t -> char -> unit
Add a single char.
  • since NEXT_RELEASE
val add_bytes : t -> bytes -> int -> int -> unit
Append given bytes slice to the buffer.
  • since 0.5
val add_string : t -> string -> unit
Add string.
  • since NEXT_RELEASE
val add_buffer : t -> Stdlib.Buffer.t -> unit
Append bytes from buffer.
  • since NEXT_RELEASE

\ No newline at end of file
+Tiny_httpd_buf (tiny_httpd.Tiny_httpd_buf)
Module Tiny_httpd_buf
Simple buffer.
These buffers are used to avoid allocating too many byte arrays when processing streams and parsing requests.
  • since 0.12
type t
val size : t -> int
val clear : t -> unit
val create : ?size:int -> unit -> t
val contents : t -> string
val bytes_slice : t -> bytes
Access underlying slice of bytes.
  • since 0.5
val contents_and_clear : t -> string
Get contents of the buffer and clear it.
  • since 0.5
val add_char : t -> char -> unit
Add a single char.
  • since NEXT_RELEASE
val add_bytes : t -> bytes -> int -> int -> unit
Append given bytes slice to the buffer.
  • since 0.5
val add_string : t -> string -> unit
Add string.
  • since NEXT_RELEASE
val add_buffer : t -> Stdlib.Buffer.t -> unit
Append bytes from buffer.
  • since NEXT_RELEASE

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_dir/Embedded_fs/index.html b/dev/tiny_httpd/Tiny_httpd_dir/Embedded_fs/index.html
index ae5c3e84..f62ccfb8 100644
--- a/dev/tiny_httpd/Tiny_httpd_dir/Embedded_fs/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_dir/Embedded_fs/index.html
@@ -1,2 +1,2 @@
 
-Embedded_fs (tiny_httpd.Tiny_httpd_dir.Embedded_fs)
Module Tiny_httpd_dir.Embedded_fs
An embedded file system, as a list of files with (relative) paths. This is useful in combination with the "tiny-httpd-mkfs" tool, which embeds the files it's given into a OCaml module.
  • since 0.12
type t
The pseudo-filesystem
val create : ?mtime:float -> unit -> t
val add_file : ?mtime:float -> t -> path:string -> string -> unit
Add file to the virtual file system.
  • raises Invalid_argument 
    if the path contains '..' or if it tries to make a directory out of an existing path that is a file.
val to_vfs : t -> (module VFS)

\ No newline at end of file
+Embedded_fs (tiny_httpd.Tiny_httpd_dir.Embedded_fs)
Module Tiny_httpd_dir.Embedded_fs
An embedded file system, as a list of files with (relative) paths. This is useful in combination with the "tiny-httpd-mkfs" tool, which embeds the files it's given into a OCaml module.
  • since 0.12
type t
The pseudo-filesystem
val create : ?mtime:float -> unit -> t
val add_file : ?mtime:float -> t -> path:string -> string -> unit
Add file to the virtual file system.
  • raises Invalid_argument 
    if the path contains '..' or if it tries to make a directory out of an existing path that is a file.
val to_vfs : t -> (module VFS)

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_dir/index.html b/dev/tiny_httpd/Tiny_httpd_dir/index.html
index f6310bf2..4cac65ee 100644
--- a/dev/tiny_httpd/Tiny_httpd_dir/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_dir/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_dir (tiny_httpd.Tiny_httpd_dir)
Module Tiny_httpd_dir
Serving static content from directories
This module provides the same functionality as the "http_of_dir" tool. It exposes a directory (and its subdirectories), with the optional ability to delete or upload files.
  • since 0.11
type dir_behavior = 
  1. | Index
    (*
    Redirect to index.html if present, else fails.
    *)
  2. | Lists
    (*
    Lists content of directory. Be careful of security implications.
    *)
  3. | Index_or_lists
    (*
    Redirect to index.html if present and lists content otherwise. This is useful for tilde ("~") directories and other per-user behavior, but be mindful of security implications
    *)
  4. | Forbidden
    (*
    Forbid access to directory. This is suited for serving assets, for example.
    *)
behavior of static directory.
This controls what happens when the user requests the path to a directory rather than a file.
type hidden
Type used to prevent users from building a config directly. Use default_config or config instead.
type config = {
  1. mutable download : bool;
    (*
    Is downloading files allowed?
    *)
  2. mutable dir_behavior : dir_behavior;
    (*
    Behavior when serving a directory and not a file
    *)
  3. mutable delete : bool;
    (*
    Is deleting a file allowed? (with method DELETE)
    *)
  4. mutable upload : bool;
    (*
    Is uploading a file allowed? (with method PUT)
    *)
  5. mutable max_upload_size : int;
    (*
    If upload is true, this is the maximum size in bytes for uploaded files.
    *)
  6. _rest : hidden;
    (*
    Just ignore this field.
    *)
}
configuration for static file handlers. This might get more fields over time.
val default_config : unit -> config
default configuration: 
+Tiny_httpd_dir (tiny_httpd.Tiny_httpd_dir)
Module Tiny_httpd_dir
Serving static content from directories
This module provides the same functionality as the "http_of_dir" tool. It exposes a directory (and its subdirectories), with the optional ability to delete or upload files.
  • since 0.11
type dir_behavior = 
  1. | Index
    (*
    Redirect to index.html if present, else fails.
    *)
  2. | Lists
    (*
    Lists content of directory. Be careful of security implications.
    *)
  3. | Index_or_lists
    (*
    Redirect to index.html if present and lists content otherwise. This is useful for tilde ("~") directories and other per-user behavior, but be mindful of security implications
    *)
  4. | Forbidden
    (*
    Forbid access to directory. This is suited for serving assets, for example.
    *)
behavior of static directory.
This controls what happens when the user requests the path to a directory rather than a file.
type hidden
Type used to prevent users from building a config directly. Use default_config or config instead.
type config = {
  1. mutable download : bool;
    (*
    Is downloading files allowed?
    *)
  2. mutable dir_behavior : dir_behavior;
    (*
    Behavior when serving a directory and not a file
    *)
  3. mutable delete : bool;
    (*
    Is deleting a file allowed? (with method DELETE)
    *)
  4. mutable upload : bool;
    (*
    Is uploading a file allowed? (with method PUT)
    *)
  5. mutable max_upload_size : int;
    (*
    If upload is true, this is the maximum size in bytes for uploaded files.
    *)
  6. _rest : hidden;
    (*
    Just ignore this field.
    *)
}
configuration for static file handlers. This might get more fields over time.
val default_config : unit -> config
default configuration: 
   { download=true
   ; dir_behavior=Forbidden
   ; delete=false
diff --git a/dev/tiny_httpd/Tiny_httpd_dir/module-type-VFS/index.html b/dev/tiny_httpd/Tiny_httpd_dir/module-type-VFS/index.html
index 21235004..0d0d410b 100644
--- a/dev/tiny_httpd/Tiny_httpd_dir/module-type-VFS/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_dir/module-type-VFS/index.html
@@ -1,2 +1,2 @@
 
-VFS (tiny_httpd.Tiny_httpd_dir.VFS)
Module type Tiny_httpd_dir.VFS
Virtual file system.
This is used to emulate a file system from pure OCaml functions and data, e.g. for resources bundled inside the web server.
  • since 0.12
val descr : string
Description of the VFS
val is_directory : string -> bool
val contains : string -> bool
file_exists vfs path returns true if path points to a file or directory inside vfs.
val list_dir : string -> string array
List directory. This only returns basenames, the files need to be put in the directory path using Filename.concat.
val delete : string -> unit
Delete path
val create : string -> (bytes -> int -> int -> unit) * (unit -> unit)
Create a file and obtain a pair write, close
val read_file_content : string -> Tiny_httpd_stream.t
Read content of a file
val file_size : string -> int option
File size, e.g. using "stat"
val file_mtime : string -> float option
File modification time, e.g. using "stat"

\ No newline at end of file
+VFS (tiny_httpd.Tiny_httpd_dir.VFS)
Module type Tiny_httpd_dir.VFS
Virtual file system.
This is used to emulate a file system from pure OCaml functions and data, e.g. for resources bundled inside the web server.
  • since 0.12
val descr : string
Description of the VFS
val is_directory : string -> bool
val contains : string -> bool
file_exists vfs path returns true if path points to a file or directory inside vfs.
val list_dir : string -> string array
List directory. This only returns basenames, the files need to be put in the directory path using Filename.concat.
val delete : string -> unit
Delete path
val create : string -> (bytes -> int -> int -> unit) * (unit -> unit)
Create a file and obtain a pair write, close
val read_file_content : string -> Tiny_httpd_stream.t
Read content of a file
val file_size : string -> int option
File size, e.g. using "stat"
val file_mtime : string -> float option
File modification time, e.g. using "stat"

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_html/index.html b/dev/tiny_httpd/Tiny_httpd_html/index.html
index d7250740..ffeaff66 100644
--- a/dev/tiny_httpd/Tiny_httpd_html/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_html/index.html
@@ -1,4 +1,4 @@
 
-Tiny_httpd_html (tiny_httpd.Tiny_httpd_html)
Module Tiny_httpd_html
HTML combinators.
This module provides combinators to produce html. It doesn't enforce the well-formedness of the html, unlike Tyxml, but it's simple and should be reasonably efficient.
  • since 0.12
module IO = Tiny_httpd_io
Output for HTML combinators.
type attribute = string * string
An attribute, i.e. a key/value pair
type elt = Out.t -> unit
A html element. It is represented by its output function, so we can directly print it.
type void = ?if_:bool -> attribute list -> elt
Element without children.
type nary = ?if_:bool -> attribute list -> elt list -> elt
Element with children, represented as a list.
  • parameter if_ 
    if false, do not print anything (default true)
type sub_elt = [ 
  1. | `E of elt
  2. | `L of elt list
  3. | `S of elt Stdlib.Seq.t
  4. | `Nil
 ]
A chunk of sub-elements, possibly empty.
type nary' = ?if_:bool -> attribute list -> sub_elt list -> elt
Element with children, represented as a list of sub_elt to be flattened
  • parameter if_ 
    if false, do not print anything (default true)
val sub_e : elt -> sub_elt
Sub-element with a single element inside.
val sub_l : elt list -> sub_elt
Sub-element with a list of items inside.
val sub_seq : elt Stdlib.Seq.t -> sub_elt
Sub-element with a sequence (Seq.t) of items inside.
val seq_of_array : 'a array -> 'b Stdlib.Seq.t
Helper to build a Seq.t from an array.
val sub_empty : sub_elt
Sub-element with nothing inside. Useful in conditionals, when one decides not to emit a sub-element at all.
val txt : string -> elt
Emit a string value, which will be escaped.
val txtf : 
+Tiny_httpd_html (tiny_httpd.Tiny_httpd_html)
Module Tiny_httpd_html
HTML combinators.
This module provides combinators to produce html. It doesn't enforce the well-formedness of the html, unlike Tyxml, but it's simple and should be reasonably efficient.
  • since 0.12
module IO = Tiny_httpd_io
Output for HTML combinators.
type attribute = string * string
An attribute, i.e. a key/value pair
type elt = Out.t -> unit
A html element. It is represented by its output function, so we can directly print it.
type void = ?if_:bool -> attribute list -> elt
Element without children.
type nary = ?if_:bool -> attribute list -> elt list -> elt
Element with children, represented as a list.
  • parameter if_ 
    if false, do not print anything (default true)
type sub_elt = [ 
  1. | `E of elt
  2. | `L of elt list
  3. | `S of elt Stdlib.Seq.t
  4. | `Nil
 ]
A chunk of sub-elements, possibly empty.
type nary' = ?if_:bool -> attribute list -> sub_elt list -> elt
Element with children, represented as a list of sub_elt to be flattened
  • parameter if_ 
    if false, do not print anything (default true)
val sub_e : elt -> sub_elt
Sub-element with a single element inside.
val sub_l : elt list -> sub_elt
Sub-element with a list of items inside.
val sub_seq : elt Stdlib.Seq.t -> sub_elt
Sub-element with a sequence (Seq.t) of items inside.
val seq_of_array : 'a array -> 'b Stdlib.Seq.t
Helper to build a Seq.t from an array.
val sub_empty : sub_elt
Sub-element with nothing inside. Useful in conditionals, when one decides not to emit a sub-element at all.
val txt : string -> elt
Emit a string value, which will be escaped.
val txtf : 
   ('a, Stdlib.Format.formatter, unit, Out.t -> unit) Stdlib.format4 ->
   'b
Formatted version of txt
val raw_html : string -> elt
Emit raw HTML. Caution, this can lead to injection vulnerabilities, never use with text that comes from untrusted users.
val area : void
tag "area", see mdn
val base : void
tag "base", see mdn
val br : void
tag "br", see mdn
val col : void
tag "col", see mdn
val embed : void
tag "embed", see mdn
val hr : void
tag "hr", see mdn
val img : void
tag "img", see mdn
val input : void
tag "input", see mdn
tag "link", see mdn
val menuitem : void
tag "menuitem", see mdn
val meta : void
tag "meta", see mdn
val param : void
tag "param", see mdn
val source : void
tag "source", see mdn
val track : void
tag "track", see mdn
val wbr : void
tag "wbr", see mdn
val a : nary
tag "a", see mdn
val a' : nary'
tag "a", see mdn
val abbr : nary
tag "abbr", see mdn
val abbr' : nary'
tag "abbr", see mdn
val address : nary
tag "address", see mdn
val address' : nary'
tag "address", see mdn
val article : nary
tag "article", see mdn
val article' : nary'
tag "article", see mdn
val aside : nary
tag "aside", see mdn
val aside' : nary'
tag "aside", see mdn
val audio : nary
tag "audio", see mdn
val audio' : nary'
tag "audio", see mdn
val b : nary
tag "b", see mdn
val b' : nary'
tag "b", see mdn
val bdi : nary
tag "bdi", see mdn
val bdi' : nary'
tag "bdi", see mdn
val bdo : nary
tag "bdo", see mdn
val bdo' : nary'
tag "bdo", see mdn
val blockquote : nary
tag "blockquote", see mdn
val blockquote' : nary'
tag "blockquote", see mdn
val body : nary
tag "body", see mdn
val body' : nary'
tag "body", see mdn
val button : nary
tag "button", see mdn
val button' : nary'
tag "button", see mdn
val canvas : nary
tag "canvas", see mdn
val canvas' : nary'
tag "canvas", see mdn
val caption : nary
tag "caption", see mdn
val caption' : nary'
tag "caption", see mdn
val cite : nary
tag "cite", see mdn
val cite' : nary'
tag "cite", see mdn
val code : nary
tag "code", see mdn
val code' : nary'
tag "code", see mdn
val colgroup : nary
tag "colgroup", see mdn
val colgroup' : nary'
tag "colgroup", see mdn
val data : nary
tag "data", see mdn
val data' : nary'
tag "data", see mdn
val datalist : nary
tag "datalist", see mdn
val datalist' : nary'
tag "datalist", see mdn
val dd : nary
tag "dd", see mdn
val dd' : nary'
tag "dd", see mdn
val del : nary
tag "del", see mdn
val del' : nary'
tag "del", see mdn
val details : nary
tag "details", see mdn
val details' : nary'
tag "details", see mdn
val dfn : nary
tag "dfn", see mdn
val dfn' : nary'
tag "dfn", see mdn
val dialog : nary
tag "dialog", see mdn
val dialog' : nary'
tag "dialog", see mdn
val div : nary
tag "div", see mdn
val div' : nary'
tag "div", see mdn
val dl : nary
tag "dl", see mdn
val dl' : nary'
tag "dl", see mdn
val dt : nary
tag "dt", see mdn
val dt' : nary'
tag "dt", see mdn
val em : nary
tag "em", see mdn
val em' : nary'
tag "em", see mdn
val fieldset : nary
tag "fieldset", see mdn
val fieldset' : nary'
tag "fieldset", see mdn
val figcaption : nary
tag "figcaption", see mdn
val figcaption' : nary'
tag "figcaption", see mdn
val figure : nary
tag "figure", see mdn
val figure' : nary'
tag "figure", see mdn
tag "footer", see mdn
val footer' : nary'
tag "footer", see mdn
val form : nary
tag "form", see mdn
val form' : nary'
tag "form", see mdn
val h1 : nary
tag "h1", see mdn
val h1' : nary'
tag "h1", see mdn
val h2 : nary
tag "h2", see mdn
val h2' : nary'
tag "h2", see mdn
val h3 : nary
tag "h3", see mdn
val h3' : nary'
tag "h3", see mdn
val h4 : nary
tag "h4", see mdn
val h4' : nary'
tag "h4", see mdn
val h5 : nary
tag "h5", see mdn
val h5' : nary'
tag "h5", see mdn
val h6 : nary
tag "h6", see mdn
val h6' : nary'
tag "h6", see mdn
val head : nary
tag "head", see mdn
val head' : nary'
tag "head", see mdn
val header : nary
tag "header", see mdn
val header' : nary'
tag "header", see mdn
val hgroup : nary
tag "hgroup", see mdn
val hgroup' : nary'
tag "hgroup", see mdn
val html : nary
tag "html", see mdn
val html' : nary'
tag "html", see mdn
val i : nary
tag "i", see mdn
val i' : nary'
tag "i", see mdn
val iframe : nary
tag "iframe", see mdn
val iframe' : nary'
tag "iframe", see mdn
val ins : nary
tag "ins", see mdn
val ins' : nary'
tag "ins", see mdn
val kbd : nary
tag "kbd", see mdn
val kbd' : nary'
tag "kbd", see mdn
val label : nary
tag "label", see mdn
val label' : nary'
tag "label", see mdn
val legend : nary
tag "legend", see mdn
val legend' : nary'
tag "legend", see mdn
val li : nary
tag "li", see mdn
val li' : nary'
tag "li", see mdn
val main : nary
tag "main", see mdn
val main' : nary'
tag "main", see mdn
val map : nary
tag "map", see mdn
val map' : nary'
tag "map", see mdn
val mark : nary
tag "mark", see mdn
val mark' : nary'
tag "mark", see mdn
val math : nary
tag "math", see mdn
val math' : nary'
tag "math", see mdn
val menu : nary
tag "menu", see mdn
val menu' : nary'
tag "menu", see mdn
val meter : nary
tag "meter", see mdn
val meter' : nary'
tag "meter", see mdn
val nav : nary
tag "nav", see mdn
val nav' : nary'
tag "nav", see mdn
val noscript : nary
tag "noscript", see mdn
val noscript' : nary'
tag "noscript", see mdn
val object_ : nary
tag "object", see mdn
val object_' : nary'
tag "object", see mdn
val ol : nary
tag "ol", see mdn
val ol' : nary'
tag "ol", see mdn
val optgroup : nary
tag "optgroup", see mdn
val optgroup' : nary'
tag "optgroup", see mdn
val option : nary
tag "option", see mdn
val option' : nary'
tag "option", see mdn
val output : nary
tag "output", see mdn
val output' : nary'
tag "output", see mdn
val p : nary
tag "p", see mdn
val p' : nary'
tag "p", see mdn
val picture : nary
tag "picture", see mdn
val picture' : nary'
tag "picture", see mdn
val pre : nary
tag "pre", see mdn
val pre' : nary'
tag "pre", see mdn
val progress : nary
tag "progress", see mdn
val progress' : nary'
tag "progress", see mdn
val q : nary
tag "q", see mdn
val q' : nary'
tag "q", see mdn
val rb : nary
tag "rb", see mdn
val rb' : nary'
tag "rb", see mdn
val rp : nary
tag "rp", see mdn
val rp' : nary'
tag "rp", see mdn
val rt : nary
tag "rt", see mdn
val rt' : nary'
tag "rt", see mdn
val rtc : nary
tag "rtc", see mdn
val rtc' : nary'
tag "rtc", see mdn
val ruby : nary
tag "ruby", see mdn
val ruby' : nary'
tag "ruby", see mdn
val s : nary
tag "s", see mdn
val s' : nary'
tag "s", see mdn
val samp : nary
tag "samp", see mdn
val samp' : nary'
tag "samp", see mdn
val script : nary
tag "script", see mdn
val script' : nary'
tag "script", see mdn
val section : nary
tag "section", see mdn
val section' : nary'
tag "section", see mdn
val select : nary
tag "select", see mdn
val select' : nary'
tag "select", see mdn
val slot : nary
tag "slot", see mdn
val slot' : nary'
tag "slot", see mdn
val small : nary
tag "small", see mdn
val small' : nary'
tag "small", see mdn
val span : nary
tag "span", see mdn
val span' : nary'
tag "span", see mdn
val strong : nary
tag "strong", see mdn
val strong' : nary'
tag "strong", see mdn
val style : nary
tag "style", see mdn
val style' : nary'
tag "style", see mdn
val sub : nary
tag "sub", see mdn
val sub' : nary'
tag "sub", see mdn
val summary : nary
tag "summary", see mdn
val summary' : nary'
tag "summary", see mdn
val sup : nary
tag "sup", see mdn
val sup' : nary'
tag "sup", see mdn
val svg : nary
tag "svg", see mdn
val svg' : nary'
tag "svg", see mdn
val table : nary
tag "table", see mdn
val table' : nary'
tag "table", see mdn
val tbody : nary
tag "tbody", see mdn
val tbody' : nary'
tag "tbody", see mdn
val td : nary
tag "td", see mdn
val td' : nary'
tag "td", see mdn
val template : nary
tag "template", see mdn
val template' : nary'
tag "template", see mdn
val textarea : nary
tag "textarea", see mdn
val textarea' : nary'
tag "textarea", see mdn
val tfoot : nary
tag "tfoot", see mdn
val tfoot' : nary'
tag "tfoot", see mdn
val th : nary
tag "th", see mdn
val th' : nary'
tag "th", see mdn
val thead : nary
tag "thead", see mdn
val thead' : nary'
tag "thead", see mdn
val time : nary
tag "time", see mdn
val time' : nary'
tag "time", see mdn
val title : nary
tag "title", see mdn
val title' : nary'
tag "title", see mdn
val tr : nary
tag "tr", see mdn
val tr' : nary'
tag "tr", see mdn
val u : nary
tag "u", see mdn
val u' : nary'
tag "u", see mdn
val ul : nary
tag "ul", see mdn
val ul' : nary'
tag "ul", see mdn
val var : nary
tag "var", see mdn
val var' : nary'
tag "var", see mdn
val video : nary
tag "video", see mdn
val video' : nary'
tag "video", see mdn
Attributes.
val to_out_channel : ?top:bool -> elt -> IO.Out_channel.t -> unit
Write an HTML element to this out channel.
  • parameter top 
    if true, add DOCTYPE at the beginning. The top element should then be a "html" tag.
  • since NEXT_RELEASE
val to_string : ?top:bool -> elt -> string
Convert a HTML element to a string.
  • parameter top 
    if true, add DOCTYPE at the beginning. The top element should then be a "html" tag.
val to_string_l : elt list -> string
Convert a list of HTML elements to a string. This is designed for fragments of HTML that are to be injected inside a bigger context, as it's invalid to have multiple elements at the toplevel of a HTML document.
val to_string_top : elt -> string
val to_out_channel_top : elt -> IO.Out_channel.t -> unit
Write a toplevel element to an output channel.
  • since NEXT_RELEASE
val to_writer : ?top:bool -> elt -> IO.Writer.t
Produce a streaming writer from this HTML element.
  • since NEXT_RELEASE
val to_stream : elt -> Tiny_httpd_stream.t
Convert a HTML element to a stream. This might just convert it to a string first, do not assume it to be more efficient.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_html_/A/index.html b/dev/tiny_httpd/Tiny_httpd_html_/A/index.html
index 48a2a04e..76232721 100644
--- a/dev/tiny_httpd/Tiny_httpd_html_/A/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_html_/A/index.html
@@ -1,2 +1,2 @@
 
-A (tiny_httpd.Tiny_httpd_html_.A)
Module Tiny_httpd_html_.A
Attributes.
This module contains combinator for the standard attributes. One can also just use a pair of strings.
type t = string -> attribute
Attribute builder
val accept : t
Attribute "accept".
val accept_charset : t
Attribute "accept-charset".
val accesskey : t
Attribute "accesskey".
val action : t
Attribute "action".
val align : t
Attribute "align".
val allow : t
Attribute "allow".
val alt : t
Attribute "alt".
val async : t
Attribute "async".
val autocapitalize : t
Attribute "autocapitalize".
val autocomplete : t
Attribute "autocomplete".
val autofocus : t
Attribute "autofocus".
val autoplay : t
Attribute "autoplay".
val buffered : t
Attribute "buffered".
val capture : t
Attribute "capture".
val challenge : t
Attribute "challenge".
val charset : t
Attribute "charset".
val checked : t
Attribute "checked".
val cite : t
Attribute "cite".
val class_ : t
Attribute "class".
val code : t
Attribute "code".
val codebase : t
Attribute "codebase".
val cols : t
Attribute "cols".
val colspan : t
Attribute "colspan".
val content : t
Attribute "content".
val contenteditable : t
Attribute "contenteditable".
val contextmenu : t
Attribute "contextmenu".
val controls : t
Attribute "controls".
val coords : t
Attribute "coords".
val crossorigin : t
Attribute "crossorigin".
val csp : t
Attribute "csp".
val data : t
Attribute "data".
val data_star : t
Attribute "data-*".
val datetime : t
Attribute "datetime".
val decoding : t
Attribute "decoding".
val default : t
Attribute "default".
val defer : t
Attribute "defer".
val dir : t
Attribute "dir".
val dirname : t
Attribute "dirname".
val disabled : t
Attribute "disabled".
val download : t
Attribute "download".
val draggable : t
Attribute "draggable".
val enctype : t
Attribute "enctype".
val enterkeyhint : t
Attribute "enterkeyhint".
val for_ : t
Attribute "for".
val form : t
Attribute "form".
val formaction : t
Attribute "formaction".
val formenctype : t
Attribute "formenctype".
val formmethod : t
Attribute "formmethod".
val formnovalidate : t
Attribute "formnovalidate".
val formtarget : t
Attribute "formtarget".
val headers : t
Attribute "headers".
val hidden : t
Attribute "hidden".
val high : t
Attribute "high".
val href : t
Attribute "href".
val hreflang : t
Attribute "hreflang".
val http_equiv : t
Attribute "http-equiv".
val icon : t
Attribute "icon".
val id : t
Attribute "id".
val importance : t
Attribute "importance".
val integrity : t
Attribute "integrity".
val ismap : t
Attribute "ismap".
val itemprop : t
Attribute "itemprop".
val keytype : t
Attribute "keytype".
val kind : t
Attribute "kind".
val label : t
Attribute "label".
val lang : t
Attribute "lang".
val language : t
Attribute "language".
val list : t
Attribute "list".
val loop : t
Attribute "loop".
val low : t
Attribute "low".
val manifest : t
Attribute "manifest".
val max : t
Attribute "max".
val maxlength : t
Attribute "maxlength".
val minlength : t
Attribute "minlength".
val media : t
Attribute "media".
val method_ : t
Attribute "method".
val min : t
Attribute "min".
val multiple : t
Attribute "multiple".
val muted : t
Attribute "muted".
val name : t
Attribute "name".
val novalidate : t
Attribute "novalidate".
val open_ : t
Attribute "open".
val optimum : t
Attribute "optimum".
val pattern : t
Attribute "pattern".
val ping : t
Attribute "ping".
val placeholder : t
Attribute "placeholder".
val poster : t
Attribute "poster".
val preload : t
Attribute "preload".
val radiogroup : t
Attribute "radiogroup".
val readonly : t
Attribute "readonly".
val referrerpolicy : t
Attribute "referrerpolicy".
val rel : t
Attribute "rel".
val required : t
Attribute "required".
val reversed : t
Attribute "reversed".
val rows : t
Attribute "rows".
val rowspan : t
Attribute "rowspan".
val sandbox : t
Attribute "sandbox".
val scope : t
Attribute "scope".
val scoped : t
Attribute "scoped".
val selected : t
Attribute "selected".
val shape : t
Attribute "shape".
val size : t
Attribute "size".
val sizes : t
Attribute "sizes".
val slot : t
Attribute "slot".
val span : t
Attribute "span".
val spellcheck : t
Attribute "spellcheck".
val src : t
Attribute "src".
val srcdoc : t
Attribute "srcdoc".
val srclang : t
Attribute "srclang".
val srcset : t
Attribute "srcset".
val start : t
Attribute "start".
val step : t
Attribute "step".
val style : t
Attribute "style".
val summary : t
Attribute "summary".
val tabindex : t
Attribute "tabindex".
val target : t
Attribute "target".
val title : t
Attribute "title".
val translate : t
Attribute "translate".
val text : t
Attribute "Text".
val type_ : t
Attribute "type".
val usemap : t
Attribute "usemap".
val value : t
Attribute "value".
val width : t
Attribute "width".
val wrap : t
Attribute "wrap".

\ No newline at end of file
+A (tiny_httpd.Tiny_httpd_html_.A)
Module Tiny_httpd_html_.A
Attributes.
This module contains combinator for the standard attributes. One can also just use a pair of strings.
type t = string -> attribute
Attribute builder
val accept : t
Attribute "accept".
val accept_charset : t
Attribute "accept-charset".
val accesskey : t
Attribute "accesskey".
val action : t
Attribute "action".
val align : t
Attribute "align".
val allow : t
Attribute "allow".
val alt : t
Attribute "alt".
val async : t
Attribute "async".
val autocapitalize : t
Attribute "autocapitalize".
val autocomplete : t
Attribute "autocomplete".
val autofocus : t
Attribute "autofocus".
val autoplay : t
Attribute "autoplay".
val buffered : t
Attribute "buffered".
val capture : t
Attribute "capture".
val challenge : t
Attribute "challenge".
val charset : t
Attribute "charset".
val checked : t
Attribute "checked".
val cite : t
Attribute "cite".
val class_ : t
Attribute "class".
val code : t
Attribute "code".
val codebase : t
Attribute "codebase".
val cols : t
Attribute "cols".
val colspan : t
Attribute "colspan".
val content : t
Attribute "content".
val contenteditable : t
Attribute "contenteditable".
val contextmenu : t
Attribute "contextmenu".
val controls : t
Attribute "controls".
val coords : t
Attribute "coords".
val crossorigin : t
Attribute "crossorigin".
val csp : t
Attribute "csp".
val data : t
Attribute "data".
val data_star : t
Attribute "data-*".
val datetime : t
Attribute "datetime".
val decoding : t
Attribute "decoding".
val default : t
Attribute "default".
val defer : t
Attribute "defer".
val dir : t
Attribute "dir".
val dirname : t
Attribute "dirname".
val disabled : t
Attribute "disabled".
val download : t
Attribute "download".
val draggable : t
Attribute "draggable".
val enctype : t
Attribute "enctype".
val enterkeyhint : t
Attribute "enterkeyhint".
val for_ : t
Attribute "for".
val form : t
Attribute "form".
val formaction : t
Attribute "formaction".
val formenctype : t
Attribute "formenctype".
val formmethod : t
Attribute "formmethod".
val formnovalidate : t
Attribute "formnovalidate".
val formtarget : t
Attribute "formtarget".
val headers : t
Attribute "headers".
val hidden : t
Attribute "hidden".
val high : t
Attribute "high".
val href : t
Attribute "href".
val hreflang : t
Attribute "hreflang".
val http_equiv : t
Attribute "http-equiv".
val icon : t
Attribute "icon".
val id : t
Attribute "id".
val importance : t
Attribute "importance".
val integrity : t
Attribute "integrity".
val ismap : t
Attribute "ismap".
val itemprop : t
Attribute "itemprop".
val keytype : t
Attribute "keytype".
val kind : t
Attribute "kind".
val label : t
Attribute "label".
val lang : t
Attribute "lang".
val language : t
Attribute "language".
val list : t
Attribute "list".
val loop : t
Attribute "loop".
val low : t
Attribute "low".
val manifest : t
Attribute "manifest".
val max : t
Attribute "max".
val maxlength : t
Attribute "maxlength".
val minlength : t
Attribute "minlength".
val media : t
Attribute "media".
val method_ : t
Attribute "method".
val min : t
Attribute "min".
val multiple : t
Attribute "multiple".
val muted : t
Attribute "muted".
val name : t
Attribute "name".
val novalidate : t
Attribute "novalidate".
val open_ : t
Attribute "open".
val optimum : t
Attribute "optimum".
val pattern : t
Attribute "pattern".
val ping : t
Attribute "ping".
val placeholder : t
Attribute "placeholder".
val poster : t
Attribute "poster".
val preload : t
Attribute "preload".
val radiogroup : t
Attribute "radiogroup".
val readonly : t
Attribute "readonly".
val referrerpolicy : t
Attribute "referrerpolicy".
val rel : t
Attribute "rel".
val required : t
Attribute "required".
val reversed : t
Attribute "reversed".
val rows : t
Attribute "rows".
val rowspan : t
Attribute "rowspan".
val sandbox : t
Attribute "sandbox".
val scope : t
Attribute "scope".
val scoped : t
Attribute "scoped".
val selected : t
Attribute "selected".
val shape : t
Attribute "shape".
val size : t
Attribute "size".
val sizes : t
Attribute "sizes".
val slot : t
Attribute "slot".
val span : t
Attribute "span".
val spellcheck : t
Attribute "spellcheck".
val src : t
Attribute "src".
val srcdoc : t
Attribute "srcdoc".
val srclang : t
Attribute "srclang".
val srcset : t
Attribute "srcset".
val start : t
Attribute "start".
val step : t
Attribute "step".
val style : t
Attribute "style".
val summary : t
Attribute "summary".
val tabindex : t
Attribute "tabindex".
val target : t
Attribute "target".
val title : t
Attribute "title".
val translate : t
Attribute "translate".
val text : t
Attribute "Text".
val type_ : t
Attribute "type".
val usemap : t
Attribute "usemap".
val value : t
Attribute "value".
val width : t
Attribute "width".
val wrap : t
Attribute "wrap".

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_html_/Out/index.html b/dev/tiny_httpd/Tiny_httpd_html_/Out/index.html
index 2fd0f8d4..b47b1071 100644
--- a/dev/tiny_httpd/Tiny_httpd_html_/Out/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_html_/Out/index.html
@@ -1,2 +1,2 @@
 
-Out (tiny_httpd.Tiny_httpd_html_.Out)
Module Tiny_httpd_html_.Out
Output for HTML combinators.
This output type is used to produce a string reasonably efficiently from a tree of combinators.
NOTE: this is experimental and an unstable API.
  • since 0.12
type t
val create_of_buffer : Stdlib.Buffer.t -> t
val create_of_out : Tiny_httpd_io.Out_channel.t -> t
val flush : t -> unit
val add_char : t -> char -> unit
val add_string : t -> string -> unit
val add_format_nl : t -> unit
val with_no_format_nl : t -> (unit -> 'a) -> 'a

\ No newline at end of file
+Out (tiny_httpd.Tiny_httpd_html_.Out)
Module Tiny_httpd_html_.Out
Output for HTML combinators.
This output type is used to produce a string reasonably efficiently from a tree of combinators.
NOTE: this is experimental and an unstable API.
  • since 0.12
type t
val create_of_buffer : Stdlib.Buffer.t -> t
val create_of_out : Tiny_httpd_io.Out_channel.t -> t
val flush : t -> unit
val add_char : t -> char -> unit
val add_string : t -> string -> unit
val add_format_nl : t -> unit
val with_no_format_nl : t -> (unit -> 'a) -> 'a

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_html_/index.html b/dev/tiny_httpd/Tiny_httpd_html_/index.html
index db2adb23..df3357ab 100644
--- a/dev/tiny_httpd/Tiny_httpd_html_/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_html_/index.html
@@ -1,4 +1,4 @@
 
-Tiny_httpd_html_ (tiny_httpd.Tiny_httpd_html_)
Module Tiny_httpd_html_
module Out : sig ... end
Output for HTML combinators.
type attribute = string * string
An attribute, i.e. a key/value pair
type elt = Out.t -> unit
A html element. It is represented by its output function, so we can directly print it.
type void = ?if_:bool -> attribute list -> elt
Element without children.
type nary = ?if_:bool -> attribute list -> elt list -> elt
Element with children, represented as a list.
  • parameter if_ 
    if false, do not print anything (default true)
type sub_elt = [ 
  1. | `E of elt
  2. | `L of elt list
  3. | `S of elt Stdlib.Seq.t
  4. | `Nil
 ]
A chunk of sub-elements, possibly empty.
type nary' = ?if_:bool -> attribute list -> sub_elt list -> elt
Element with children, represented as a list of sub_elt to be flattened
  • parameter if_ 
    if false, do not print anything (default true)
val sub_e : elt -> sub_elt
Sub-element with a single element inside.
val sub_l : elt list -> sub_elt
Sub-element with a list of items inside.
val sub_seq : elt Stdlib.Seq.t -> sub_elt
Sub-element with a sequence (Seq.t) of items inside.
val seq_of_array : 'a array -> 'b Stdlib.Seq.t
Helper to build a Seq.t from an array.
val sub_empty : sub_elt
Sub-element with nothing inside. Useful in conditionals, when one decides not to emit a sub-element at all.
val txt : string -> elt
Emit a string value, which will be escaped.
val txtf : 
+Tiny_httpd_html_ (tiny_httpd.Tiny_httpd_html_)
Module Tiny_httpd_html_
module Out : sig ... end
Output for HTML combinators.
type attribute = string * string
An attribute, i.e. a key/value pair
type elt = Out.t -> unit
A html element. It is represented by its output function, so we can directly print it.
type void = ?if_:bool -> attribute list -> elt
Element without children.
type nary = ?if_:bool -> attribute list -> elt list -> elt
Element with children, represented as a list.
  • parameter if_ 
    if false, do not print anything (default true)
type sub_elt = [ 
  1. | `E of elt
  2. | `L of elt list
  3. | `S of elt Stdlib.Seq.t
  4. | `Nil
 ]
A chunk of sub-elements, possibly empty.
type nary' = ?if_:bool -> attribute list -> sub_elt list -> elt
Element with children, represented as a list of sub_elt to be flattened
  • parameter if_ 
    if false, do not print anything (default true)
val sub_e : elt -> sub_elt
Sub-element with a single element inside.
val sub_l : elt list -> sub_elt
Sub-element with a list of items inside.
val sub_seq : elt Stdlib.Seq.t -> sub_elt
Sub-element with a sequence (Seq.t) of items inside.
val seq_of_array : 'a array -> 'b Stdlib.Seq.t
Helper to build a Seq.t from an array.
val sub_empty : sub_elt
Sub-element with nothing inside. Useful in conditionals, when one decides not to emit a sub-element at all.
val txt : string -> elt
Emit a string value, which will be escaped.
val txtf : 
   ('a, Stdlib.Format.formatter, unit, Out.t -> unit) Stdlib.format4 ->
   'b
Formatted version of txt
val raw_html : string -> elt
Emit raw HTML. Caution, this can lead to injection vulnerabilities, never use with text that comes from untrusted users.
val area : void
tag "area", see mdn
val base : void
tag "base", see mdn
val br : void
tag "br", see mdn
val col : void
tag "col", see mdn
val embed : void
tag "embed", see mdn
val hr : void
tag "hr", see mdn
val img : void
tag "img", see mdn
val input : void
tag "input", see mdn
tag "link", see mdn
val menuitem : void
tag "menuitem", see mdn
val meta : void
tag "meta", see mdn
val param : void
tag "param", see mdn
val source : void
tag "source", see mdn
val track : void
tag "track", see mdn
val wbr : void
tag "wbr", see mdn
val a : nary
tag "a", see mdn
val a' : nary'
tag "a", see mdn
val abbr : nary
tag "abbr", see mdn
val abbr' : nary'
tag "abbr", see mdn
val address : nary
tag "address", see mdn
val address' : nary'
tag "address", see mdn
val article : nary
tag "article", see mdn
val article' : nary'
tag "article", see mdn
val aside : nary
tag "aside", see mdn
val aside' : nary'
tag "aside", see mdn
val audio : nary
tag "audio", see mdn
val audio' : nary'
tag "audio", see mdn
val b : nary
tag "b", see mdn
val b' : nary'
tag "b", see mdn
val bdi : nary
tag "bdi", see mdn
val bdi' : nary'
tag "bdi", see mdn
val bdo : nary
tag "bdo", see mdn
val bdo' : nary'
tag "bdo", see mdn
val blockquote : nary
tag "blockquote", see mdn
val blockquote' : nary'
tag "blockquote", see mdn
val body : nary
tag "body", see mdn
val body' : nary'
tag "body", see mdn
val button : nary
tag "button", see mdn
val button' : nary'
tag "button", see mdn
val canvas : nary
tag "canvas", see mdn
val canvas' : nary'
tag "canvas", see mdn
val caption : nary
tag "caption", see mdn
val caption' : nary'
tag "caption", see mdn
val cite : nary
tag "cite", see mdn
val cite' : nary'
tag "cite", see mdn
val code : nary
tag "code", see mdn
val code' : nary'
tag "code", see mdn
val colgroup : nary
tag "colgroup", see mdn
val colgroup' : nary'
tag "colgroup", see mdn
val data : nary
tag "data", see mdn
val data' : nary'
tag "data", see mdn
val datalist : nary
tag "datalist", see mdn
val datalist' : nary'
tag "datalist", see mdn
val dd : nary
tag "dd", see mdn
val dd' : nary'
tag "dd", see mdn
val del : nary
tag "del", see mdn
val del' : nary'
tag "del", see mdn
val details : nary
tag "details", see mdn
val details' : nary'
tag "details", see mdn
val dfn : nary
tag "dfn", see mdn
val dfn' : nary'
tag "dfn", see mdn
val dialog : nary
tag "dialog", see mdn
val dialog' : nary'
tag "dialog", see mdn
val div : nary
tag "div", see mdn
val div' : nary'
tag "div", see mdn
val dl : nary
tag "dl", see mdn
val dl' : nary'
tag "dl", see mdn
val dt : nary
tag "dt", see mdn
val dt' : nary'
tag "dt", see mdn
val em : nary
tag "em", see mdn
val em' : nary'
tag "em", see mdn
val fieldset : nary
tag "fieldset", see mdn
val fieldset' : nary'
tag "fieldset", see mdn
val figcaption : nary
tag "figcaption", see mdn
val figcaption' : nary'
tag "figcaption", see mdn
val figure : nary
tag "figure", see mdn
val figure' : nary'
tag "figure", see mdn
tag "footer", see mdn
val footer' : nary'
tag "footer", see mdn
val form : nary
tag "form", see mdn
val form' : nary'
tag "form", see mdn
val h1 : nary
tag "h1", see mdn
val h1' : nary'
tag "h1", see mdn
val h2 : nary
tag "h2", see mdn
val h2' : nary'
tag "h2", see mdn
val h3 : nary
tag "h3", see mdn
val h3' : nary'
tag "h3", see mdn
val h4 : nary
tag "h4", see mdn
val h4' : nary'
tag "h4", see mdn
val h5 : nary
tag "h5", see mdn
val h5' : nary'
tag "h5", see mdn
val h6 : nary
tag "h6", see mdn
val h6' : nary'
tag "h6", see mdn
val head : nary
tag "head", see mdn
val head' : nary'
tag "head", see mdn
val header : nary
tag "header", see mdn
val header' : nary'
tag "header", see mdn
val hgroup : nary
tag "hgroup", see mdn
val hgroup' : nary'
tag "hgroup", see mdn
val html : nary
tag "html", see mdn
val html' : nary'
tag "html", see mdn
val i : nary
tag "i", see mdn
val i' : nary'
tag "i", see mdn
val iframe : nary
tag "iframe", see mdn
val iframe' : nary'
tag "iframe", see mdn
val ins : nary
tag "ins", see mdn
val ins' : nary'
tag "ins", see mdn
val kbd : nary
tag "kbd", see mdn
val kbd' : nary'
tag "kbd", see mdn
val label : nary
tag "label", see mdn
val label' : nary'
tag "label", see mdn
val legend : nary
tag "legend", see mdn
val legend' : nary'
tag "legend", see mdn
val li : nary
tag "li", see mdn
val li' : nary'
tag "li", see mdn
val main : nary
tag "main", see mdn
val main' : nary'
tag "main", see mdn
val map : nary
tag "map", see mdn
val map' : nary'
tag "map", see mdn
val mark : nary
tag "mark", see mdn
val mark' : nary'
tag "mark", see mdn
val math : nary
tag "math", see mdn
val math' : nary'
tag "math", see mdn
val menu : nary
tag "menu", see mdn
val menu' : nary'
tag "menu", see mdn
val meter : nary
tag "meter", see mdn
val meter' : nary'
tag "meter", see mdn
val nav : nary
tag "nav", see mdn
val nav' : nary'
tag "nav", see mdn
val noscript : nary
tag "noscript", see mdn
val noscript' : nary'
tag "noscript", see mdn
val object_ : nary
tag "object", see mdn
val object_' : nary'
tag "object", see mdn
val ol : nary
tag "ol", see mdn
val ol' : nary'
tag "ol", see mdn
val optgroup : nary
tag "optgroup", see mdn
val optgroup' : nary'
tag "optgroup", see mdn
val option : nary
tag "option", see mdn
val option' : nary'
tag "option", see mdn
val output : nary
tag "output", see mdn
val output' : nary'
tag "output", see mdn
val p : nary
tag "p", see mdn
val p' : nary'
tag "p", see mdn
val picture : nary
tag "picture", see mdn
val picture' : nary'
tag "picture", see mdn
val pre : nary
tag "pre", see mdn
val pre' : nary'
tag "pre", see mdn
val progress : nary
tag "progress", see mdn
val progress' : nary'
tag "progress", see mdn
val q : nary
tag "q", see mdn
val q' : nary'
tag "q", see mdn
val rb : nary
tag "rb", see mdn
val rb' : nary'
tag "rb", see mdn
val rp : nary
tag "rp", see mdn
val rp' : nary'
tag "rp", see mdn
val rt : nary
tag "rt", see mdn
val rt' : nary'
tag "rt", see mdn
val rtc : nary
tag "rtc", see mdn
val rtc' : nary'
tag "rtc", see mdn
val ruby : nary
tag "ruby", see mdn
val ruby' : nary'
tag "ruby", see mdn
val s : nary
tag "s", see mdn
val s' : nary'
tag "s", see mdn
val samp : nary
tag "samp", see mdn
val samp' : nary'
tag "samp", see mdn
val script : nary
tag "script", see mdn
val script' : nary'
tag "script", see mdn
val section : nary
tag "section", see mdn
val section' : nary'
tag "section", see mdn
val select : nary
tag "select", see mdn
val select' : nary'
tag "select", see mdn
val slot : nary
tag "slot", see mdn
val slot' : nary'
tag "slot", see mdn
val small : nary
tag "small", see mdn
val small' : nary'
tag "small", see mdn
val span : nary
tag "span", see mdn
val span' : nary'
tag "span", see mdn
val strong : nary
tag "strong", see mdn
val strong' : nary'
tag "strong", see mdn
val style : nary
tag "style", see mdn
val style' : nary'
tag "style", see mdn
val sub : nary
tag "sub", see mdn
val sub' : nary'
tag "sub", see mdn
val summary : nary
tag "summary", see mdn
val summary' : nary'
tag "summary", see mdn
val sup : nary
tag "sup", see mdn
val sup' : nary'
tag "sup", see mdn
val svg : nary
tag "svg", see mdn
val svg' : nary'
tag "svg", see mdn
val table : nary
tag "table", see mdn
val table' : nary'
tag "table", see mdn
val tbody : nary
tag "tbody", see mdn
val tbody' : nary'
tag "tbody", see mdn
val td : nary
tag "td", see mdn
val td' : nary'
tag "td", see mdn
val template : nary
tag "template", see mdn
val template' : nary'
tag "template", see mdn
val textarea : nary
tag "textarea", see mdn
val textarea' : nary'
tag "textarea", see mdn
val tfoot : nary
tag "tfoot", see mdn
val tfoot' : nary'
tag "tfoot", see mdn
val th : nary
tag "th", see mdn
val th' : nary'
tag "th", see mdn
val thead : nary
tag "thead", see mdn
val thead' : nary'
tag "thead", see mdn
val time : nary
tag "time", see mdn
val time' : nary'
tag "time", see mdn
val title : nary
tag "title", see mdn
val title' : nary'
tag "title", see mdn
val tr : nary
tag "tr", see mdn
val tr' : nary'
tag "tr", see mdn
val u : nary
tag "u", see mdn
val u' : nary'
tag "u", see mdn
val ul : nary
tag "ul", see mdn
val ul' : nary'
tag "ul", see mdn
val var : nary
tag "var", see mdn
val var' : nary'
tag "var", see mdn
val video : nary
tag "video", see mdn
val video' : nary'
tag "video", see mdn
module A : sig ... end
Attributes.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_io/In_channel/index.html b/dev/tiny_httpd/Tiny_httpd_io/In_channel/index.html
index 550db665..80243abc 100644
--- a/dev/tiny_httpd/Tiny_httpd_io/In_channel/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_io/In_channel/index.html
@@ -1,2 +1,2 @@
 
-In_channel (tiny_httpd.Tiny_httpd_io.In_channel)
Module Tiny_httpd_io.In_channel
Input channel (byte source)
type t = {
  1. input : bytes -> int -> int -> int;
    (*
    Read into the slice. Returns 0 only if the channel is closed.
    *)
  2. close : unit -> unit;
    (*
    Close the input. Must be idempotent.
    *)
}
An input channel, i.e an incoming stream of bytes.
This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input channel, etc.
val of_in_channel : ?close_noerr:bool -> Stdlib.in_channel -> t
val of_unix_fd : ?close_noerr:bool -> Unix.file_descr -> t
val input : t -> bytes -> int -> int -> int
Read into the given slice.
  • returns 
    the number of bytes read, 0 means end of input.
val close : t -> unit
Close the channel.

\ No newline at end of file
+In_channel (tiny_httpd.Tiny_httpd_io.In_channel)
Module Tiny_httpd_io.In_channel
Input channel (byte source)
type t = {
  1. input : bytes -> int -> int -> int;
    (*
    Read into the slice. Returns 0 only if the channel is closed.
    *)
  2. close : unit -> unit;
    (*
    Close the input. Must be idempotent.
    *)
}
An input channel, i.e an incoming stream of bytes.
This can be a string, an int_channel, an Unix.file_descr, a decompression wrapper around another input channel, etc.
val of_in_channel : ?close_noerr:bool -> Stdlib.in_channel -> t
val of_unix_fd : ?close_noerr:bool -> Unix.file_descr -> t
val input : t -> bytes -> int -> int -> int
Read into the given slice.
  • returns 
    the number of bytes read, 0 means end of input.
val close : t -> unit
Close the channel.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_io/Out_channel/index.html b/dev/tiny_httpd/Tiny_httpd_io/Out_channel/index.html
index 9ab67f15..77319b12 100644
--- a/dev/tiny_httpd/Tiny_httpd_io/Out_channel/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_io/Out_channel/index.html
@@ -1,2 +1,2 @@
 
-Out_channel (tiny_httpd.Tiny_httpd_io.Out_channel)
Module Tiny_httpd_io.Out_channel
Output channel (byte sink)
type t = {
  1. output_char : char -> unit;
    (*
    Output a single char
    *)
  2. output : bytes -> int -> int -> unit;
    (*
    Output slice
    *)
  3. flush : unit -> unit;
    (*
    Flush underlying buffer
    *)
  4. close : unit -> unit;
    (*
    Close the output. Must be idempotent.
    *)
}
An output channel, ie. a place into which we can write bytes.
This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.
val of_out_channel : ?close_noerr:bool -> Stdlib.out_channel -> t
of_out_channel oc wraps the channel into a Out_channel.t.
  • parameter close_noerr 
    if true, then closing the result uses close_out_noerr instead of close_out to close oc
val of_buffer : Stdlib.Buffer.t -> t
of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.
val output_char : t -> char -> unit
Output the buffer slice into this channel
val output : t -> bytes -> int -> int -> unit
Output the buffer slice into this channel
val output_string : t -> string -> unit
val close : t -> unit
Close the channel.
val flush : t -> unit
Flush (ie. force write) any buffered bytes.
val output_buf : t -> Buf.t -> unit
val chunk_encoding : ?buf:Buf.t -> close_rec:bool -> t -> t
chunk_encoding oc makes a new channel that outputs its content into oc in chunk encoding form.
  • parameter close_rec 
    if true, closing the result will also close oc
  • parameter buf 
    a buffer used to accumulate data into chunks. Chunks are emitted when buf's size gets over a certain threshold, or when flush is called.

\ No newline at end of file
+Out_channel (tiny_httpd.Tiny_httpd_io.Out_channel)
Module Tiny_httpd_io.Out_channel
Output channel (byte sink)
type t = {
  1. output_char : char -> unit;
    (*
    Output a single char
    *)
  2. output : bytes -> int -> int -> unit;
    (*
    Output slice
    *)
  3. flush : unit -> unit;
    (*
    Flush underlying buffer
    *)
  4. close : unit -> unit;
    (*
    Close the output. Must be idempotent.
    *)
}
An output channel, ie. a place into which we can write bytes.
This can be a Buffer.t, an out_channel, a Unix.file_descr, etc.
val of_out_channel : ?close_noerr:bool -> Stdlib.out_channel -> t
of_out_channel oc wraps the channel into a Out_channel.t.
  • parameter close_noerr 
    if true, then closing the result uses close_out_noerr instead of close_out to close oc
val of_buffer : Stdlib.Buffer.t -> t
of_buffer buf is an output channel that writes directly into buf. flush and close have no effect.
val output_char : t -> char -> unit
Output the buffer slice into this channel
val output : t -> bytes -> int -> int -> unit
Output the buffer slice into this channel
val output_string : t -> string -> unit
val close : t -> unit
Close the channel.
val flush : t -> unit
Flush (ie. force write) any buffered bytes.
val output_buf : t -> Buf.t -> unit
val chunk_encoding : ?buf:Buf.t -> close_rec:bool -> t -> t
chunk_encoding oc makes a new channel that outputs its content into oc in chunk encoding form.
  • parameter close_rec 
    if true, closing the result will also close oc
  • parameter buf 
    a buffer used to accumulate data into chunks. Chunks are emitted when buf's size gets over a certain threshold, or when flush is called.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_io/TCP_server/index.html b/dev/tiny_httpd/Tiny_httpd_io/TCP_server/index.html
index f6cb4b89..5d6007ac 100644
--- a/dev/tiny_httpd/Tiny_httpd_io/TCP_server/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_io/TCP_server/index.html
@@ -1,2 +1,2 @@
 
-TCP_server (tiny_httpd.Tiny_httpd_io.TCP_server)
Module Tiny_httpd_io.TCP_server
A TCP server abstraction.
type conn_handler = {
  1. handle : In_channel.t -> Out_channel.t -> unit;
    (*
    Handle client connection
    *)
}
type t = {
  1. endpoint : unit -> string * int;
    (*
    Endpoint we listen on. This can only be called from within serve.
    *)
  2. active_connections : unit -> int;
    (*
    Number of connections currently active
    *)
  3. running : unit -> bool;
    (*
    Is the server currently running?
    *)
  4. stop : unit -> unit;
    (*
    Ask the server to stop. This might not take effect immediately, and is idempotent. After this server.running() must return false.
    *)
}
A running TCP server.
This contains some functions that provide information about the running server, including whether it's active (as opposed to stopped), a function to stop it, and statistics about the number of connections.
type builder = {
  1. serve : after_init:(t -> unit) -> handle:conn_handler -> unit -> unit;
    (*
    Blocking call to listen for incoming connections and handle them. Uses the connection handler handle to handle individual client connections in individual threads/fibers/tasks.
    • parameter after_init 
      is called once with the server after the server has started.
    *)
}
A TCP server builder implementation.
Calling builder.serve ~after_init ~handle () starts a new TCP server on an unspecified endpoint (most likely coming from the function returning this builder) and returns the running server.

\ No newline at end of file
+TCP_server (tiny_httpd.Tiny_httpd_io.TCP_server)
Module Tiny_httpd_io.TCP_server
A TCP server abstraction.
type conn_handler = {
  1. handle : In_channel.t -> Out_channel.t -> unit;
    (*
    Handle client connection
    *)
}
type t = {
  1. endpoint : unit -> string * int;
    (*
    Endpoint we listen on. This can only be called from within serve.
    *)
  2. active_connections : unit -> int;
    (*
    Number of connections currently active
    *)
  3. running : unit -> bool;
    (*
    Is the server currently running?
    *)
  4. stop : unit -> unit;
    (*
    Ask the server to stop. This might not take effect immediately, and is idempotent. After this server.running() must return false.
    *)
}
A running TCP server.
This contains some functions that provide information about the running server, including whether it's active (as opposed to stopped), a function to stop it, and statistics about the number of connections.
type builder = {
  1. serve : after_init:(t -> unit) -> handle:conn_handler -> unit -> unit;
    (*
    Blocking call to listen for incoming connections and handle them. Uses the connection handler handle to handle individual client connections in individual threads/fibers/tasks.
    • parameter after_init 
      is called once with the server after the server has started.
    *)
}
A TCP server builder implementation.
Calling builder.serve ~after_init ~handle () starts a new TCP server on an unspecified endpoint (most likely coming from the function returning this builder) and returns the running server.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_io/Writer/index.html b/dev/tiny_httpd/Tiny_httpd_io/Writer/index.html
index 0d020926..34bb813c 100644
--- a/dev/tiny_httpd/Tiny_httpd_io/Writer/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_io/Writer/index.html
@@ -1,2 +1,2 @@
 
-Writer (tiny_httpd.Tiny_httpd_io.Writer)
Module Tiny_httpd_io.Writer
A writer abstraction.
type t = {
  1. write : Out_channel.t -> unit;
}
Writer.
A writer is a push-based stream of bytes. Give it an output channel and it will write the bytes in it.
This is useful for responses: an http endpoint can return a writer as its response's body, and output into it as if it were a regular out_channel, including controlling calls to flush.
  • since NEXT_RELEASE
val make : write:(Out_channel.t -> unit) -> unit -> t
val write : Out_channel.t -> t -> unit
Write into the channel.
val empty : t
Empty writer, will output 0 bytes.
val of_string : string -> t
A writer that just emits the bytes from the given string.

\ No newline at end of file
+Writer (tiny_httpd.Tiny_httpd_io.Writer)
Module Tiny_httpd_io.Writer
A writer abstraction.
type t = {
  1. write : Out_channel.t -> unit;
}
Writer.
A writer is a push-based stream of bytes. Give it an output channel and it will write the bytes in it.
This is useful for responses: an http endpoint can return a writer as its response's body, and output into it as if it were a regular out_channel, including controlling calls to flush.
  • since NEXT_RELEASE
val make : write:(Out_channel.t -> unit) -> unit -> t
val write : Out_channel.t -> t -> unit
Write into the channel.
val empty : t
Empty writer, will output 0 bytes.
val of_string : string -> t
A writer that just emits the bytes from the given string.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_io/index.html b/dev/tiny_httpd/Tiny_httpd_io/index.html
index 5debb293..21b119c8 100644
--- a/dev/tiny_httpd/Tiny_httpd_io/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_io/index.html
@@ -1,2 +1,2 @@
 
-Tiny_httpd_io (tiny_httpd.Tiny_httpd_io)
Module Tiny_httpd_io
IO abstraction.
We abstract IO so we can support classic unix blocking IOs with threads, and modern async IO with Eio.
NOTE: experimental.
  • since NEXT_RELEASE
module Buf = Tiny_httpd_buf
module In_channel : sig ... end
Input channel (byte source)
module Out_channel : sig ... end
Output channel (byte sink)
module Writer : sig ... end
A writer abstraction.
module TCP_server : sig ... end
A TCP server abstraction.

\ No newline at end of file
+Tiny_httpd_io (tiny_httpd.Tiny_httpd_io)
Module Tiny_httpd_io
IO abstraction.
We abstract IO so we can support classic unix blocking IOs with threads, and modern async IO with Eio.
NOTE: experimental.
  • since NEXT_RELEASE
module Buf = Tiny_httpd_buf
module In_channel : sig ... end
Input channel (byte source)
module Out_channel : sig ... end
Output channel (byte sink)
module Writer : sig ... end
A writer abstraction.
module TCP_server : sig ... end
A TCP server abstraction.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_pool/index.html b/dev/tiny_httpd/Tiny_httpd_pool/index.html
index 6e38e97e..95ecfe21 100644
--- a/dev/tiny_httpd/Tiny_httpd_pool/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_pool/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_pool (tiny_httpd.Tiny_httpd_pool)
Module Tiny_httpd_pool
Resource pool.
This pool is used for buffers. It can be used for other resources but do note that it assumes resources are still reasonably cheap to produce and discard, and will never block waiting for a resource — it's not a good pool for DB connections.
  • since NEXT_RELEASE.
type 'a t
Pool of values of type 'a
val create : 
+Tiny_httpd_pool (tiny_httpd.Tiny_httpd_pool)
Module Tiny_httpd_pool
Resource pool.
This pool is used for buffers. It can be used for other resources but do note that it assumes resources are still reasonably cheap to produce and discard, and will never block waiting for a resource — it's not a good pool for DB connections.
  • since NEXT_RELEASE.
type 'a t
Pool of values of type 'a
val create : 
   ?clear:('a -> unit) ->
   mk_item:(unit -> 'a) ->
   ?max_size:int ->
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Headers/index.html b/dev/tiny_httpd/Tiny_httpd_server/Headers/index.html
index 72efa1e4..f418a291 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Headers/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Headers/index.html
@@ -1,2 +1,2 @@
 
-Headers (tiny_httpd.Tiny_httpd_server.Headers)
Module Tiny_httpd_server.Headers
type t = (string * string) list
The header files of a request or response.
Neither the key nor the value can contain '\r' or '\n'. See https://tools.ietf.org/html/rfc7230#section-3.2
val empty : t
Empty list of headers.
  • since 0.5
val get : ?f:(string -> string) -> string -> t -> string option
get k headers looks for the header field with key k.
  • parameter f 
    if provided, will transform the value before it is returned.
val set : string -> string -> t -> t
set k v headers sets the key k to value v. It erases any previous entry for k
val remove : string -> t -> t
Remove the key from the headers, if present.
val contains : string -> t -> bool
Is there a header with the given key?
val pp : Stdlib.Format.formatter -> t -> unit
Pretty print the headers.

\ No newline at end of file
+Headers (tiny_httpd.Tiny_httpd_server.Headers)
Module Tiny_httpd_server.Headers
type t = (string * string) list
The header files of a request or response.
Neither the key nor the value can contain '\r' or '\n'. See https://tools.ietf.org/html/rfc7230#section-3.2
val empty : t
Empty list of headers.
  • since 0.5
val get : ?f:(string -> string) -> string -> t -> string option
get k headers looks for the header field with key k.
  • parameter f 
    if provided, will transform the value before it is returned.
val set : string -> string -> t -> t
set k v headers sets the key k to value v. It erases any previous entry for k
val remove : string -> t -> t
Remove the key from the headers, if present.
val contains : string -> t -> bool
Is there a header with the given key?
val pp : Stdlib.Format.formatter -> t -> unit
Pretty print the headers.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Meth/index.html b/dev/tiny_httpd/Tiny_httpd_server/Meth/index.html
index 02e4b4c0..b0b3305b 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Meth/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Meth/index.html
@@ -1,2 +1,2 @@
 
-Meth (tiny_httpd.Tiny_httpd_server.Meth)
Module Tiny_httpd_server.Meth
type t = [ 
  1. | `GET
  2. | `PUT
  3. | `POST
  4. | `HEAD
  5. | `DELETE
  6. | `OPTIONS
 ]
A HTTP method. For now we only handle a subset of these.
See https://tools.ietf.org/html/rfc7231#section-4
val pp : Stdlib.Format.formatter -> t -> unit
val to_string : t -> string

\ No newline at end of file
+Meth (tiny_httpd.Tiny_httpd_server.Meth)
Module Tiny_httpd_server.Meth
type t = [ 
  1. | `GET
  2. | `PUT
  3. | `POST
  4. | `HEAD
  5. | `DELETE
  6. | `OPTIONS
 ]
A HTTP method. For now we only handle a subset of these.
See https://tools.ietf.org/html/rfc7231#section-4
val pp : Stdlib.Format.formatter -> t -> unit
val to_string : t -> string

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Middleware/index.html b/dev/tiny_httpd/Tiny_httpd_server/Middleware/index.html
index 5a8ee6dd..70876c01 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Middleware/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Middleware/index.html
@@ -1,2 +1,2 @@
 
-Middleware (tiny_httpd.Tiny_httpd_server.Middleware)
Module Tiny_httpd_server.Middleware
type handler = byte_stream Request.t -> resp:(Response.t -> unit) -> unit
Handlers are functions returning a response to a request. The response can be delayed, hence the use of a continuation as the resp parameter.
type t = handler -> handler
A middleware is a handler transformation.
It takes the existing handler h, and returns a new one which, given a query, modify it or log it before passing it to h, or fail. It can also log or modify or drop the response.
val nil : t
Trivial middleware that does nothing.

\ No newline at end of file
+Middleware (tiny_httpd.Tiny_httpd_server.Middleware)
Module Tiny_httpd_server.Middleware
type handler = byte_stream Request.t -> resp:(Response.t -> unit) -> unit
Handlers are functions returning a response to a request. The response can be delayed, hence the use of a continuation as the resp parameter.
type t = handler -> handler
A middleware is a handler transformation.
It takes the existing handler h, and returns a new one which, given a query, modify it or log it before passing it to h, or fail. It can also log or modify or drop the response.
val nil : t
Trivial middleware that does nothing.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Request/index.html b/dev/tiny_httpd/Tiny_httpd_server/Request/index.html
index 9bf6ffcf..5af27b92 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Request/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Request/index.html
@@ -1,5 +1,5 @@
 
-Request (tiny_httpd.Tiny_httpd_server.Request)
Module Tiny_httpd_server.Request
type 'body t = private {
  1. meth : Meth.t;
    (*
    HTTP method for this request.
    *)
  2. host : string;
    (*
    Host header, mandatory. It can also be found in headers.
    *)
  3. headers : Headers.t;
    (*
    List of headers.
    *)
  4. http_version : int * int;
    (*
    HTTP version. This should be either 1, 0 or 1, 1.
    *)
  5. path : string;
    (*
    Full path of the requested URL.
    *)
  6. path_components : string list;
    (*
    Components of the path of the requested URL.
    *)
  7. query : (string * string) list;
    (*
    Query part of the requested URL.
    *)
  8. body : 'body;
    (*
    Body of the request.
    *)
  9. start_time : float;
    (*
    Obtained via get_time_s in create
    • since 0.11
    *)
}
A request with method, path, host, headers, and a body, sent by a client.
The body is polymorphic because the request goes through several transformations. First it has no body, as only the request and headers are read; then it has a stream body; then the body might be entirely read as a string via read_body_full.
  • since 0.6 The field [query] was added and contains the query parameters in ["?foo=bar,x=y"]
  • since 0.6 The field [path_components] is the part of the path that precedes [query] and is split on ["/"].
  • since 0.11 the type is a private alias
  • since 0.11 the field [start_time] was added
val pp : Stdlib.Format.formatter -> string t -> unit
Pretty print the request and its body. The exact format of this printing is not specified.
val pp_ : Stdlib.Format.formatter -> _ t -> unit
Pretty print the request without its body. The exact format of this printing is not specified.
val headers : _ t -> Headers.t
List of headers of the request, including "Host".
val get_header : ?f:(string -> string) -> _ t -> string -> string option
get_header req h looks up header h in req. It returns None if the header is not present. This is case insensitive and should be used rather than looking up h verbatim in headers.
val get_header_int : _ t -> string -> int option
Same as get_header but also performs a string to integer conversion.
val set_header : string -> string -> 'a t -> 'a t
set_header k v req sets k: v in the request req's headers.
val update_headers : (Headers.t -> Headers.t) -> 'a t -> 'a t
Modify headers using the given function.
  • since 0.11
val set_body : 'a -> _ t -> 'a t
set_body b req returns a new query whose body is b.
  • since 0.11
val host : _ t -> string
Host field of the request. It also appears in the headers.
val meth : _ t -> Meth.t
Method for the request.
val path : _ t -> string
Request path.
val query : _ t -> (string * string) list
Decode the query part of the path field.
  • since 0.4
val body : 'b t -> 'b
Request body, possibly empty.
val start_time : _ t -> float
time stamp (from Unix.gettimeofday) after parsing the first line of the request
  • since 0.11
val limit_body_size : max_size:int -> byte_stream t -> byte_stream t
Limit the body size to max_size bytes, or return a 413 error.
  • since 0.3
val read_body_full : 
+Request (tiny_httpd.Tiny_httpd_server.Request)
Module Tiny_httpd_server.Request
type 'body t = private {
  1. meth : Meth.t;
    (*
    HTTP method for this request.
    *)
  2. host : string;
    (*
    Host header, mandatory. It can also be found in headers.
    *)
  3. headers : Headers.t;
    (*
    List of headers.
    *)
  4. http_version : int * int;
    (*
    HTTP version. This should be either 1, 0 or 1, 1.
    *)
  5. path : string;
    (*
    Full path of the requested URL.
    *)
  6. path_components : string list;
    (*
    Components of the path of the requested URL.
    *)
  7. query : (string * string) list;
    (*
    Query part of the requested URL.
    *)
  8. body : 'body;
    (*
    Body of the request.
    *)
  9. start_time : float;
    (*
    Obtained via get_time_s in create
    • since 0.11
    *)
}
A request with method, path, host, headers, and a body, sent by a client.
The body is polymorphic because the request goes through several transformations. First it has no body, as only the request and headers are read; then it has a stream body; then the body might be entirely read as a string via read_body_full.
  • since 0.6 The field [query] was added and contains the query parameters in ["?foo=bar,x=y"]
  • since 0.6 The field [path_components] is the part of the path that precedes [query] and is split on ["/"].
  • since 0.11 the type is a private alias
  • since 0.11 the field [start_time] was added
val pp : Stdlib.Format.formatter -> string t -> unit
Pretty print the request and its body. The exact format of this printing is not specified.
val pp_ : Stdlib.Format.formatter -> _ t -> unit
Pretty print the request without its body. The exact format of this printing is not specified.
val headers : _ t -> Headers.t
List of headers of the request, including "Host".
val get_header : ?f:(string -> string) -> _ t -> string -> string option
get_header req h looks up header h in req. It returns None if the header is not present. This is case insensitive and should be used rather than looking up h verbatim in headers.
val get_header_int : _ t -> string -> int option
Same as get_header but also performs a string to integer conversion.
val set_header : string -> string -> 'a t -> 'a t
set_header k v req sets k: v in the request req's headers.
val update_headers : (Headers.t -> Headers.t) -> 'a t -> 'a t
Modify headers using the given function.
  • since 0.11
val set_body : 'a -> _ t -> 'a t
set_body b req returns a new query whose body is b.
  • since 0.11
val host : _ t -> string
Host field of the request. It also appears in the headers.
val meth : _ t -> Meth.t
Method for the request.
val path : _ t -> string
Request path.
val query : _ t -> (string * string) list
Decode the query part of the path field.
  • since 0.4
val body : 'b t -> 'b
Request body, possibly empty.
val start_time : _ t -> float
time stamp (from Unix.gettimeofday) after parsing the first line of the request
  • since 0.11
val limit_body_size : max_size:int -> byte_stream t -> byte_stream t
Limit the body size to max_size bytes, or return a 413 error.
  • since 0.3
val read_body_full : 
   ?buf:Tiny_httpd_buf.t ->
   ?buf_size:int ->
   byte_stream t ->
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Response/index.html b/dev/tiny_httpd/Tiny_httpd_server/Response/index.html
index b5c6e241..1ead6ece 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Response/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Response/index.html
@@ -1,19 +1,23 @@
 
-Response (tiny_httpd.Tiny_httpd_server.Response)
Module Tiny_httpd_server.Response
type body = [ 
  1. | `String of string
  2. | `Stream of byte_stream
  3. | `Writer of Tiny_httpd_io.Writer.t
  4. | `Void
 ]
Body of a response, either as a simple string, or a stream of bytes, or nothing (for server-sent events notably).
  • `String str replies with a body set to this string, and a known content-length.
  • `Stream str replies with a body made from this string, using chunked encoding.
  • `Void replies with no body.
  • `Writer w replies with a body created by the writer w, using a chunked encoding. It is available since NEXT_RELEASE.
type t = private {
  1. code : Response_code.t;
    (*
    HTTP response code. See Response_code.
    *)
  2. headers : Headers.t;
    (*
    Headers of the reply. Some will be set by Tiny_httpd automatically.
    *)
  3. body : body;
    (*
    Body of the response. Can be empty.
    *)
}
A response to send back to a client.
val set_body : body -> t -> t
Set the body of the response.
  • since 0.11
val set_header : string -> string -> t -> t
Set a header.
  • since 0.11
val update_headers : (Headers.t -> Headers.t) -> t -> t
Modify headers.
  • since 0.11
val set_headers : Headers.t -> t -> t
Set all headers.
  • since 0.11
val set_code : Response_code.t -> t -> t
Set the response code.
  • since 0.11
val make_raw : ?headers:Headers.t -> code:Response_code.t -> string -> t
Make a response from its raw components, with a string body. Use "" to not send a body at all.
val make_raw_stream : 
+Response (tiny_httpd.Tiny_httpd_server.Response)
Module Tiny_httpd_server.Response
type body = [ 
  1. | `String of string
  2. | `Stream of byte_stream
  3. | `Writer of Tiny_httpd_io.Writer.t
  4. | `Void
 ]
Body of a response, either as a simple string, or a stream of bytes, or nothing (for server-sent events notably).
  • `String str replies with a body set to this string, and a known content-length.
  • `Stream str replies with a body made from this string, using chunked encoding.
  • `Void replies with no body.
  • `Writer w replies with a body created by the writer w, using a chunked encoding. It is available since NEXT_RELEASE.
type t = private {
  1. code : Response_code.t;
    (*
    HTTP response code. See Response_code.
    *)
  2. headers : Headers.t;
    (*
    Headers of the reply. Some will be set by Tiny_httpd automatically.
    *)
  3. body : body;
    (*
    Body of the response. Can be empty.
    *)
}
A response to send back to a client.
val set_body : body -> t -> t
Set the body of the response.
  • since 0.11
val set_header : string -> string -> t -> t
Set a header.
  • since 0.11
val update_headers : (Headers.t -> Headers.t) -> t -> t
Modify headers.
  • since 0.11
val set_headers : Headers.t -> t -> t
Set all headers.
  • since 0.11
val set_code : Response_code.t -> t -> t
Set the response code.
  • since 0.11
val make_raw : ?headers:Headers.t -> code:Response_code.t -> string -> t
Make a response from its raw components, with a string body. Use "" to not send a body at all.
val make_raw_stream : 
   ?headers:Headers.t ->
   code:Response_code.t ->
   byte_stream ->
   t
Same as make_raw but with a stream body. The body will be sent with the chunked transfer-encoding.
val make_void : ?headers:Headers.t -> code:int -> unit -> t
Return a response without a body at all.
  • since 0.13
val make : 
   ?headers:Headers.t ->
+  ?code:int ->
   (body, Response_code.t * string) Stdlib.result ->
   t
make r turns a result into a response.
  • make (Ok body) replies with 200 and the body.
  • make (Error (code,msg)) replies with the given error code and message as body.
val make_string : 
   ?headers:Headers.t ->
+  ?code:int ->
   (string, Response_code.t * string) Stdlib.result ->
   t
Same as make but with a string body.
val make_writer : 
   ?headers:Headers.t ->
+  ?code:int ->
   (Tiny_httpd_io.Writer.t, Response_code.t * string) Stdlib.result ->
   t
Same as make but with a writer body.
val make_stream : 
   ?headers:Headers.t ->
+  ?code:int ->
   (byte_stream, Response_code.t * string) Stdlib.result ->
   t
Same as make but with a stream body.
val fail : 
   ?headers:Headers.t ->
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Response_code/index.html b/dev/tiny_httpd/Tiny_httpd_server/Response_code/index.html
index 587eeccd..6e84933a 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Response_code/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Response_code/index.html
@@ -1,2 +1,2 @@
 
-Response_code (tiny_httpd.Tiny_httpd_server.Response_code)
Module Tiny_httpd_server.Response_code
type t = int
A standard HTTP code.
https://tools.ietf.org/html/rfc7231#section-6
val ok : t
The code 200
val not_found : t
The code 404
val descr : t -> string
A description of some of the error codes. NOTE: this is not complete (yet).

\ No newline at end of file
+Response_code (tiny_httpd.Tiny_httpd_server.Response_code)
Module Tiny_httpd_server.Response_code
type t = int
A standard HTTP code.
https://tools.ietf.org/html/rfc7231#section-6
val ok : t
The code 200
val not_found : t
The code 404
val descr : t -> string
A description of some of the error codes. NOTE: this is not complete (yet).

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/Route/index.html b/dev/tiny_httpd/Tiny_httpd_server/Route/index.html
index 4f44e13e..25f6f090 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/Route/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/Route/index.html
@@ -1,2 +1,2 @@
 
-Route (tiny_httpd.Tiny_httpd_server.Route)
Module Tiny_httpd_server.Route
type ('a, 'b) comp
An atomic component of a path
type ('a, 'b) t
A route, composed of path components
val int : (int -> 'a, 'a) comp
Matches an integer.
val string : (string -> 'a, 'a) comp
Matches a string not containing '/' and binds it as is.
val string_urlencoded : (string -> 'a, 'a) comp
Matches a URL-encoded string, and decodes it.
val exact : string -> ('a, 'a) comp
exact "s" matches "s" and nothing else.
val return : ('a, 'a) t
Matches the empty path.
val rest_of_path : (string -> 'a, 'a) t
Matches a string, even containing '/'. This will match the entirety of the remaining route.
  • since 0.7
val rest_of_path_urlencoded : (string -> 'a, 'a) t
Matches a string, even containing '/', an URL-decode it. This will match the entirety of the remaining route.
  • since 0.7
val (@/) : ('a, 'b) comp -> ('b, 'c) t -> ('a, 'c) t
comp / route matches "foo/bar/…" iff comp matches "foo", and route matches "bar/…".
val exact_path : string -> ('a, 'b) t -> ('a, 'b) t
exact_path "foo/bar/..." r is equivalent to exact "foo" @/ exact "bar" @/ ... @/ r
  • since 0.11 *
val pp : Stdlib.Format.formatter -> (_, _) t -> unit
Print the route.
  • since 0.7
val to_string : (_, _) t -> string
Print the route.
  • since 0.7

\ No newline at end of file
+Route (tiny_httpd.Tiny_httpd_server.Route)
Module Tiny_httpd_server.Route
type ('a, 'b) comp
An atomic component of a path
type ('a, 'b) t
A route, composed of path components
val int : (int -> 'a, 'a) comp
Matches an integer.
val string : (string -> 'a, 'a) comp
Matches a string not containing '/' and binds it as is.
val string_urlencoded : (string -> 'a, 'a) comp
Matches a URL-encoded string, and decodes it.
val exact : string -> ('a, 'a) comp
exact "s" matches "s" and nothing else.
val return : ('a, 'a) t
Matches the empty path.
val rest_of_path : (string -> 'a, 'a) t
Matches a string, even containing '/'. This will match the entirety of the remaining route.
  • since 0.7
val rest_of_path_urlencoded : (string -> 'a, 'a) t
Matches a string, even containing '/', an URL-decode it. This will match the entirety of the remaining route.
  • since 0.7
val (@/) : ('a, 'b) comp -> ('b, 'c) t -> ('a, 'c) t
comp / route matches "foo/bar/…" iff comp matches "foo", and route matches "bar/…".
val exact_path : string -> ('a, 'b) t -> ('a, 'b) t
exact_path "foo/bar/..." r is equivalent to exact "foo" @/ exact "bar" @/ ... @/ r
  • since 0.11 *
val pp : Stdlib.Format.formatter -> (_, _) t -> unit
Print the route.
  • since 0.7
val to_string : (_, _) t -> string
Print the route.
  • since 0.7

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/index.html b/dev/tiny_httpd/Tiny_httpd_server/index.html
index 096bd777..70599ed3 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_server (tiny_httpd.Tiny_httpd_server)
Module Tiny_httpd_server
HTTP server.
This module implements a very simple, basic HTTP/1.1 server using blocking IOs and threads.
It is possible to use a thread pool, see create's argument new_thread.
  • since 0.13
type buf = Tiny_httpd_buf.t
type byte_stream = Tiny_httpd_stream.t
HTTP Methods
module Meth : sig ... end
Headers
Headers are metadata associated with a request or response.
module Headers : sig ... end
Requests
Requests are sent by a client, e.g. a web browser or cURL. From the point of view of the server, they're inputs.
module Request : sig ... end
Response Codes
module Response_code : sig ... end
Responses
Responses are what a http server, such as Tiny_httpd, send back to the client to answer a Request.t
module Response : sig ... end
Routing
Basic type-safe routing of handlers based on URL paths. This is optional, it is possible to only define the root handler with something like Routes.
  • since 0.6
module Route : sig ... end
Middlewares
A middleware can be inserted in a handler to modify or observe its behavior.
  • since 0.11
module Middleware : sig ... end
Main Server type
type t
A HTTP server. See create for more details.
val create : 
+Tiny_httpd_server (tiny_httpd.Tiny_httpd_server)
Module Tiny_httpd_server
HTTP server.
This module implements a very simple, basic HTTP/1.1 server using blocking IOs and threads.
It is possible to use a thread pool, see create's argument new_thread.
  • since 0.13
type buf = Tiny_httpd_buf.t
type byte_stream = Tiny_httpd_stream.t
HTTP Methods
module Meth : sig ... end
Headers
Headers are metadata associated with a request or response.
module Headers : sig ... end
Requests
Requests are sent by a client, e.g. a web browser or cURL. From the point of view of the server, they're inputs.
module Request : sig ... end
Response Codes
module Response_code : sig ... end
Responses
Responses are what a http server, such as Tiny_httpd, send back to the client to answer a Request.t
module Response : sig ... end
Routing
Basic type-safe routing of handlers based on URL paths. This is optional, it is possible to only define the root handler with something like Routes.
  • since 0.6
module Route : sig ... end
Middlewares
A middleware can be inserted in a handler to modify or observe its behavior.
  • since 0.11
module Middleware : sig ... end
Main Server type
type t
A HTTP server. See create for more details.
val create : 
   ?masksigpipe:bool ->
   ?max_connections:int ->
   ?timeout:float ->
diff --git a/dev/tiny_httpd/Tiny_httpd_server/module-type-IO_BACKEND/index.html b/dev/tiny_httpd/Tiny_httpd_server/module-type-IO_BACKEND/index.html
index ba821ed3..a012de2f 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/module-type-IO_BACKEND/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/module-type-IO_BACKEND/index.html
@@ -1,2 +1,2 @@
 
-IO_BACKEND (tiny_httpd.Tiny_httpd_server.IO_BACKEND)
Module type Tiny_httpd_server.IO_BACKEND
A backend that provides IO operations, network operations, etc.
This is used to decouple tiny_httpd from the scheduler/IO library used to actually open a TCP server and talk to clients. The classic way is based on Unix and blocking IOs, but it's also possible to use an OCaml 5 library using effects and non blocking IOs.
val init_addr : unit -> string
Initial TCP address
val init_port : unit -> int
Initial port
val get_time_s : unit -> float
Obtain the current timestamp in seconds.
val tcp_server : unit -> Tiny_httpd_io.TCP_server.builder
TCP server builder, to create servers that can listen on a port and handle clients.

\ No newline at end of file
+IO_BACKEND (tiny_httpd.Tiny_httpd_server.IO_BACKEND)
Module type Tiny_httpd_server.IO_BACKEND
A backend that provides IO operations, network operations, etc.
This is used to decouple tiny_httpd from the scheduler/IO library used to actually open a TCP server and talk to clients. The classic way is based on Unix and blocking IOs, but it's also possible to use an OCaml 5 library using effects and non blocking IOs.
val init_addr : unit -> string
Initial TCP address
val init_port : unit -> int
Initial port
val get_time_s : unit -> float
Obtain the current timestamp in seconds.
val tcp_server : unit -> Tiny_httpd_io.TCP_server.builder
TCP server builder, to create servers that can listen on a port and handle clients.

\ No newline at end of file
diff --git a/dev/tiny_httpd/Tiny_httpd_server/module-type-SERVER_SENT_GENERATOR/index.html b/dev/tiny_httpd/Tiny_httpd_server/module-type-SERVER_SENT_GENERATOR/index.html
index 225e4a60..7f729f5c 100644
--- a/dev/tiny_httpd/Tiny_httpd_server/module-type-SERVER_SENT_GENERATOR/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_server/module-type-SERVER_SENT_GENERATOR/index.html
@@ -1,5 +1,5 @@
 
-SERVER_SENT_GENERATOR (tiny_httpd.Tiny_httpd_server.SERVER_SENT_GENERATOR)
Module type Tiny_httpd_server.SERVER_SENT_GENERATOR
A server-side function to generate of Server-sent events.
See the w3c page and this blog post.
  • since 0.9
val set_headers : Headers.t -> unit
Set headers of the response. This is not mandatory but if used at all, it must be called before any call to send_event (once events are sent the response is already sent too).
val send_event : 
+SERVER_SENT_GENERATOR (tiny_httpd.Tiny_httpd_server.SERVER_SENT_GENERATOR)
Module type Tiny_httpd_server.SERVER_SENT_GENERATOR
A server-side function to generate of Server-sent events.
See the w3c page and this blog post.
  • since 0.9
val set_headers : Headers.t -> unit
Set headers of the response. This is not mandatory but if used at all, it must be called before any call to send_event (once events are sent the response is already sent too).
val send_event : 
   ?event:string ->
   ?id:string ->
   ?retry:string ->
diff --git a/dev/tiny_httpd/Tiny_httpd_stream/index.html b/dev/tiny_httpd/Tiny_httpd_stream/index.html
index ce448efe..dc6a8729 100644
--- a/dev/tiny_httpd/Tiny_httpd_stream/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_stream/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_stream (tiny_httpd.Tiny_httpd_stream)
Module Tiny_httpd_stream
Byte streams.
Streams are used to represent a series of bytes that can arrive progressively. For example, an uploaded file will be sent as a series of chunks.
These used to live in Tiny_httpd but are now in their own module.
  • since 0.12
type hidden
Type used to make t unbuildable via a record literal. Use make instead.
type t = {
  1. mutable bs : bytes;
    (*
    The bytes
    *)
  2. mutable off : int;
    (*
    Beginning of valid slice in bs
    *)
  3. mutable len : int;
    (*
    Length of valid slice in bs. If len = 0 after a call to fill, then the stream is finished.
    *)
  4. fill_buf : unit -> unit;
    (*
    See the current slice of the internal buffer as bytes, i, len, where the slice is bytes[i] .. [bytes[i+len-1]]. Can block to refill the buffer if there is currently no content. If len=0 then there is no more data.
    *)
  5. consume : int -> unit;
    (*
    Consume n bytes from the buffer. This should only be called with n <= len.
    *)
  6. close : unit -> unit;
    (*
    Close the stream.
    *)
  7. _rest : hidden;
    (*
    Use make to build a stream.
    *)
}
A buffered stream, with a view into the current buffer (or refill if empty), and a function to consume n bytes.
The point of this type is that it gives the caller access to its internal buffer (bs, with the slice off,len). This is convenient for things like line reading where one needs to peek ahead.
Some core invariant for this type of stream are:
  • off,len delimits a valid slice in bs (indices: off, off+1, … off+len-1)
  • if fill_buf() was just called, then either len=0 which indicates the end of stream; or len>0 and the slice contains some data.
To actually move forward in the stream, you can call consume n to consume n bytes (where n <= len). If len gets to 0, calling fill_buf() is required, so it can try to obtain a new slice.
To emulate a classic OCaml reader with a read: bytes -> int -> int -> int function, the simplest is:
let read (self:t) buf offset max_len : int =
+Tiny_httpd_stream (tiny_httpd.Tiny_httpd_stream)
Module Tiny_httpd_stream
Byte streams.
Streams are used to represent a series of bytes that can arrive progressively. For example, an uploaded file will be sent as a series of chunks.
These used to live in Tiny_httpd but are now in their own module.
  • since 0.12
type hidden
Type used to make t unbuildable via a record literal. Use make instead.
type t = {
  1. mutable bs : bytes;
    (*
    The bytes
    *)
  2. mutable off : int;
    (*
    Beginning of valid slice in bs
    *)
  3. mutable len : int;
    (*
    Length of valid slice in bs. If len = 0 after a call to fill, then the stream is finished.
    *)
  4. fill_buf : unit -> unit;
    (*
    See the current slice of the internal buffer as bytes, i, len, where the slice is bytes[i] .. [bytes[i+len-1]]. Can block to refill the buffer if there is currently no content. If len=0 then there is no more data.
    *)
  5. consume : int -> unit;
    (*
    Consume n bytes from the buffer. This should only be called with n <= len.
    *)
  6. close : unit -> unit;
    (*
    Close the stream.
    *)
  7. _rest : hidden;
    (*
    Use make to build a stream.
    *)
}
A buffered stream, with a view into the current buffer (or refill if empty), and a function to consume n bytes.
The point of this type is that it gives the caller access to its internal buffer (bs, with the slice off,len). This is convenient for things like line reading where one needs to peek ahead.
Some core invariant for this type of stream are:
  • off,len delimits a valid slice in bs (indices: off, off+1, … off+len-1)
  • if fill_buf() was just called, then either len=0 which indicates the end of stream; or len>0 and the slice contains some data.
To actually move forward in the stream, you can call consume n to consume n bytes (where n <= len). If len gets to 0, calling fill_buf() is required, so it can try to obtain a new slice.
To emulate a classic OCaml reader with a read: bytes -> int -> int -> int function, the simplest is:
let read (self:t) buf offset max_len : int =
   self.fill_buf();
   let len = min max_len self.len in
   if len > 0 then (
diff --git a/dev/tiny_httpd/Tiny_httpd_util/index.html b/dev/tiny_httpd/Tiny_httpd_util/index.html
index 16ac2da7..aa681744 100644
--- a/dev/tiny_httpd/Tiny_httpd_util/index.html
+++ b/dev/tiny_httpd/Tiny_httpd_util/index.html
@@ -1,2 +1,2 @@
 
-Tiny_httpd_util (tiny_httpd.Tiny_httpd_util)
Module Tiny_httpd_util
Some utils for writing web servers
  • since 0.2
val percent_encode : ?skip:(char -> bool) -> string -> string
Encode the string into a valid path following https://tools.ietf.org/html/rfc3986#section-2.1
  • parameter skip 
    if provided, allows to preserve some characters, e.g. '/' in a path.
val percent_decode : string -> string option
Inverse operation of percent_encode. Can fail since some strings are not valid percent encodings.
val split_query : string -> string * string
Split a path between the path and the query
  • since 0.5
val split_on_slash : string -> string list
Split a string on '/', remove the trailing '/' if any.
  • since 0.6
val get_non_query_path : string -> string
get the part of the path that is not the query parameters.
  • since 0.5
val get_query : string -> string
Obtain the query part of a path.
  • since 0.4
val parse_query : string -> ((string * string) list, string) Stdlib.result
Parse a query as a list of '&' or ';' separated key=value pairs. The order might not be preserved.
  • since 0.3

\ No newline at end of file
+Tiny_httpd_util (tiny_httpd.Tiny_httpd_util)
Module Tiny_httpd_util
Some utils for writing web servers
  • since 0.2
val percent_encode : ?skip:(char -> bool) -> string -> string
Encode the string into a valid path following https://tools.ietf.org/html/rfc3986#section-2.1
  • parameter skip 
    if provided, allows to preserve some characters, e.g. '/' in a path.
val percent_decode : string -> string option
Inverse operation of percent_encode. Can fail since some strings are not valid percent encodings.
val split_query : string -> string * string
Split a path between the path and the query
  • since 0.5
val split_on_slash : string -> string list
Split a string on '/', remove the trailing '/' if any.
  • since 0.6
val get_non_query_path : string -> string
get the part of the path that is not the query parameters.
  • since 0.5
val get_query : string -> string
Obtain the query part of a path.
  • since 0.4
val parse_query : string -> ((string * string) list, string) Stdlib.result
Parse a query as a list of '&' or ';' separated key=value pairs. The order might not be preserved.
  • since 0.3

\ No newline at end of file
diff --git a/dev/tiny_httpd/index.html b/dev/tiny_httpd/index.html
index 7c2791ca..60b4ecd2 100644
--- a/dev/tiny_httpd/index.html
+++ b/dev/tiny_httpd/index.html
@@ -1,2 +1,2 @@
 
-index (tiny_httpd.index)
tiny_httpd index
Library tiny_httpd
This library exposes the following toplevel modules:

\ No newline at end of file
+index (tiny_httpd.index)
tiny_httpd index
Library tiny_httpd
This library exposes the following toplevel modules:

\ No newline at end of file
diff --git a/dev/tiny_httpd_camlzip/Tiny_httpd_camlzip/index.html b/dev/tiny_httpd_camlzip/Tiny_httpd_camlzip/index.html
index 81c20436..6bde9437 100644
--- a/dev/tiny_httpd_camlzip/Tiny_httpd_camlzip/index.html
+++ b/dev/tiny_httpd_camlzip/Tiny_httpd_camlzip/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_camlzip (tiny_httpd_camlzip.Tiny_httpd_camlzip)
Module Tiny_httpd_camlzip
Middleware for compression.
This uses camlzip to provide deflate compression/decompression. If installed, the middleware will compress responses' bodies when they are streams or fixed-size above a given limit (but it will not compress small, fixed-size bodies).
val middleware : 
+Tiny_httpd_camlzip (tiny_httpd_camlzip.Tiny_httpd_camlzip)
Module Tiny_httpd_camlzip
Middleware for compression.
This uses camlzip to provide deflate compression/decompression. If installed, the middleware will compress responses' bodies when they are streams or fixed-size above a given limit (but it will not compress small, fixed-size bodies).
val middleware : 
   ?compress_above:int ->
   ?buf_size:int ->
   unit ->
diff --git a/dev/tiny_httpd_camlzip/index.html b/dev/tiny_httpd_camlzip/index.html
index 47a8f23a..cbae8b9b 100644
--- a/dev/tiny_httpd_camlzip/index.html
+++ b/dev/tiny_httpd_camlzip/index.html
@@ -1,2 +1,2 @@
 
-index (tiny_httpd_camlzip.index)
tiny_httpd_camlzip index
Library tiny_httpd_camlzip
The entry point of this library is the module: Tiny_httpd_camlzip.

\ No newline at end of file
+index (tiny_httpd_camlzip.index)
tiny_httpd_camlzip index
Library tiny_httpd_camlzip
The entry point of this library is the module: Tiny_httpd_camlzip.

\ No newline at end of file
diff --git a/dev/tiny_httpd_eio/Tiny_httpd_eio/index.html b/dev/tiny_httpd_eio/Tiny_httpd_eio/index.html
index 06f5f37e..5fb4a32f 100644
--- a/dev/tiny_httpd_eio/Tiny_httpd_eio/index.html
+++ b/dev/tiny_httpd_eio/Tiny_httpd_eio/index.html
@@ -1,5 +1,5 @@
 
-Tiny_httpd_eio (tiny_httpd_eio.Tiny_httpd_eio)
Module Tiny_httpd_eio
Tiny httpd EIO backend.
This replaces the threads + Unix blocking syscalls of Tiny_httpd_server with an Eio-based cooperative system.
NOTE: this is very experimental and will absolutely change over time, especially since Eio itself is also subject to change.
  • since NEXT_RELEASE
type 'a with_args =
+Tiny_httpd_eio (tiny_httpd_eio.Tiny_httpd_eio)
Module Tiny_httpd_eio
Tiny httpd EIO backend.
This replaces the threads + Unix blocking syscalls of Tiny_httpd_server with an Eio-based cooperative system.
NOTE: this is very experimental and will absolutely change over time, especially since Eio itself is also subject to change.
  • since NEXT_RELEASE
type 'a with_args =
   ?addr:string ->
   ?port:int ->
   ?max_connections:int ->
diff --git a/dev/tiny_httpd_eio/index.html b/dev/tiny_httpd_eio/index.html
index 11b7f7f1..099bdc49 100644
--- a/dev/tiny_httpd_eio/index.html
+++ b/dev/tiny_httpd_eio/index.html
@@ -1,2 +1,2 @@
 
-index (tiny_httpd_eio.index)
tiny_httpd_eio index
Library tiny_httpd_eio
The entry point of this library is the module: Tiny_httpd_eio.

\ No newline at end of file
+index (tiny_httpd_eio.index)
tiny_httpd_eio index
Library tiny_httpd_eio
The entry point of this library is the module: Tiny_httpd_eio.

\ No newline at end of file