anil.recoil.org
A batteries included HTTP/1.1 client in OCaml
odoc
+2
-2
lib/auth.mli
+2
-2
lib/auth.mli
···
13
14
{2 Security}
15
16
-
Per {{:https://datatracker.ietf.org/doc/html/rfc7617#section-4}RFC 7617 Section 4}} and
17
-
{{:https://datatracker.ietf.org/doc/html/rfc6750#section-5.1}RFC 6750 Section 5.1}},
18
Basic, Bearer, and Digest authentication transmit credentials that MUST be
19
protected by TLS. The library enforces HTTPS by default for these schemes. *)
20
···
13
14
{2 Security}
15
16
+
Per {{:https://datatracker.ietf.org/doc/html/rfc7617#section-4}RFC 7617 Section 4} and
17
+
{{:https://datatracker.ietf.org/doc/html/rfc6750#section-5.1}RFC 6750 Section 5.1},
18
Basic, Bearer, and Digest authentication transmit credentials that MUST be
19
protected by TLS. The library enforces HTTPS by default for these schemes. *)
20
+2
-2
lib/headers.mli
+2
-2
lib/headers.mli
···
6
(** HTTP header field handling per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-5}RFC 9110 Section 5}
7
8
This module provides an efficient implementation of HTTP headers with
9
-
case-insensitive field names per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-5.1}RFC 9110 Section 5.1}}.
10
Headers can have multiple values for the same field name (e.g., Set-Cookie).
11
12
{2 Security}
13
14
Header names and values are validated to prevent HTTP header injection
15
attacks. CR and LF characters are rejected per
16
-
{{:https://datatracker.ietf.org/doc/html/rfc9110#section-5.5}RFC 9110 Section 5.5}}.
17
18
{2 Examples}
19
···
6
(** HTTP header field handling per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-5}RFC 9110 Section 5}
7
8
This module provides an efficient implementation of HTTP headers with
9
+
case-insensitive field names per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-5.1}RFC 9110 Section 5.1}.
10
Headers can have multiple values for the same field name (e.g., Set-Cookie).
11
12
{2 Security}
13
14
Header names and values are validated to prevent HTTP header injection
15
attacks. CR and LF characters are rejected per
16
+
{{:https://datatracker.ietf.org/doc/html/rfc9110#section-5.5}RFC 9110 Section 5.5}.
17
18
{2 Examples}
19
+1
-1
lib/method.mli
+1
-1
lib/method.mli
+2
-2
lib/one.mli
+2
-2
lib/one.mli
···
10
Each request opens a new TCP connection (with TLS for https://) that is
11
closed when the Eio switch closes.
12
13
-
Implements {{:https://datatracker.ietf.org/doc/html/rfc9112}RFC 9112}} (HTTP/1.1)
14
-
with {{:https://datatracker.ietf.org/doc/html/rfc9110}RFC 9110}} semantics.
15
16
For stateful requests with automatic cookie handling, connection pooling,
17
and persistent configuration, use the main {!Requests} module instead.
···
10
Each request opens a new TCP connection (with TLS for https://) that is
11
closed when the Eio switch closes.
12
13
+
Implements {{:https://datatracker.ietf.org/doc/html/rfc9112}RFC 9112} (HTTP/1.1)
14
+
with {{:https://datatracker.ietf.org/doc/html/rfc9110}RFC 9110} semantics.
15
16
For stateful requests with automatic cookie handling, connection pooling,
17
and persistent configuration, use the main {!Requests} module instead.
+4
-4
lib/requests.mli
+4
-4
lib/requests.mli
···
107
108
{b Exception-Based Errors:}
109
110
-
All request functions may raise exceptions from the {!Error} module:
111
- {!exception:Error.Timeout}: Request exceeded timeout limit
112
- {!exception:Error.ConnectionError}: Network connection failed
113
- {!exception:Error.TooManyRedirects}: Exceeded maximum redirect count
···
161
log_error "Unexpected error: %s" (Printexc.to_string exn)
162
]}
163
164
-
The {!Error} module also provides a Result-based API for functional error
165
handling, though the primary API uses exceptions for better integration
166
with Eio's structured concurrency.
167
···
284
HTTP requests use absolute-URI form (RFC 9112 Section 3.2.2).
285
HTTPS requests use CONNECT tunneling (RFC 9110 Section 9.3.6).
286
@param allow_insecure_auth Allow Basic/Bearer/Digest authentication over plaintext HTTP (default: false).
287
-
Per {{:https://datatracker.ietf.org/doc/html/rfc7617#section-4}RFC 7617 Section 4}} and
288
-
{{:https://datatracker.ietf.org/doc/html/rfc6750#section-5.1}RFC 6750 Section 5.1}},
289
these auth schemes transmit credentials that SHOULD be protected by TLS.
290
{b Only set to [true] for local development or testing environments.}
291
Example for local dev server:
···
107
108
{b Exception-Based Errors:}
109
110
+
All request functions may raise exceptions from the {!module:Error} module:
111
- {!exception:Error.Timeout}: Request exceeded timeout limit
112
- {!exception:Error.ConnectionError}: Network connection failed
113
- {!exception:Error.TooManyRedirects}: Exceeded maximum redirect count
···
161
log_error "Unexpected error: %s" (Printexc.to_string exn)
162
]}
163
164
+
The {!module:Error} module also provides a Result-based API for functional error
165
handling, though the primary API uses exceptions for better integration
166
with Eio's structured concurrency.
167
···
284
HTTP requests use absolute-URI form (RFC 9112 Section 3.2.2).
285
HTTPS requests use CONNECT tunneling (RFC 9110 Section 9.3.6).
286
@param allow_insecure_auth Allow Basic/Bearer/Digest authentication over plaintext HTTP (default: false).
287
+
Per {{:https://datatracker.ietf.org/doc/html/rfc7617#section-4}RFC 7617 Section 4} and
288
+
{{:https://datatracker.ietf.org/doc/html/rfc6750#section-5.1}RFC 6750 Section 5.1},
289
these auth schemes transmit credentials that SHOULD be protected by TLS.
290
{b Only set to [true] for local development or testing environments.}
291
Example for local dev server:
+1
-1
lib/response.mli
+1
-1
lib/response.mli
+2
-2
lib/retry.mli
+2
-2
lib/retry.mli
···
7
8
This module provides configurable retry logic for HTTP requests,
9
including exponential backoff, custom retry predicates, and
10
-
Retry-After header support per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-10.2.3}RFC 9110 Section 10.2.3}}.
11
12
{2 Custom Retry Predicates}
13
···
106
107
(** Parse Retry-After header value (seconds or HTTP date).
108
109
-
Per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-10.2.3}RFC 9110 Section 10.2.3}},
110
Retry-After can be either:
111
- A non-negative integer (delay in seconds)
112
- An HTTP-date (absolute time to retry after)
···
7
8
This module provides configurable retry logic for HTTP requests,
9
including exponential backoff, custom retry predicates, and
10
+
Retry-After header support per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-10.2.3}RFC 9110 Section 10.2.3}.
11
12
{2 Custom Retry Predicates}
13
···
106
107
(** Parse Retry-After header value (seconds or HTTP date).
108
109
+
Per {{:https://datatracker.ietf.org/doc/html/rfc9110#section-10.2.3}RFC 9110 Section 10.2.3},
110
Retry-After can be either:
111
- A non-negative integer (delay in seconds)
112
- An HTTP-date (absolute time to retry after)