Module Body

Log source for body operations

Abstract body type representing HTTP request body content.

empty creates an empty body (no content).

of_string mime content creates a body from a string with the specified MIME type. Example: of_string Mime.json {|{"key": "value"}|}

of_stream ?length mime stream creates a streaming body. If length is provided, it will be used for the Content-Length header, otherwise chunked encoding is used.

of_file ?mime path creates a body from a file. If mime is not provided, the MIME type is automatically detected from the file extension using the magic-mime library, which provides accurate MIME type mappings for hundreds of file extensions.

json value creates a JSON body from a Jsont.json value. The value is encoded to a JSON string with Content-Type: application/json.

Example:

  let body = Body.json (Jsont.Object ([
    ("status", Jsont.String "success");
    ("count", Jsont.Number 42.);
    ("items", Jsont.Array ([Jsont.String "first"; Jsont.String "second"], Jsont.Meta.none))
  ], Jsont.Meta.none))

jsonv codec value creates a JSON body by encoding value using the typed codec. The value is encoded to a minified JSON string with Content-Type: application/json.

This is the preferred way to create JSON bodies from typed OCaml values, as it provides type safety and works with custom record types.

Example:

  (* Define a codec for your type *)
  type user = { name : string; age : int }

  let user_codec =
    Jsont.Obj.map ~kind:"user" (fun name age -> { name; age })
    |> Jsont.Obj.mem "name" Jsont.string ~enc:(fun u -> u.name)
    |> Jsont.Obj.mem "age" Jsont.int ~enc:(fun u -> u.age)
    |> Jsont.Obj.finish

  (* Create a JSON body from a typed value *)
  let body = Body.jsonv user_codec { name = "Alice"; age = 30 }

• raises Eio.Io

  with Error.error.Json_encode_error if encoding fails.

json_stream json_value creates a streaming JSON body from a Jsont.json value. The JSON value will be encoded to a minified JSON string and streamed.

Example:

  let large_data = Jsont.Object ([
    ("users", Jsont.Array ([...], Jsont.Meta.none))
  ], Jsont.Meta.none) in
  let body = Body.json_stream large_data

text str creates a plain text body with Content-Type: text/plain.

form fields creates a URL-encoded form body with Content-Type: application/x-www-form-urlencoded. Example: form [("username", "alice"); ("password", "secret")]

A single part in a multipart body.

multipart parts creates a multipart/form-data body from a list of parts. This is commonly used for file uploads and complex form submissions.

Example:

  let body = Body.multipart [
    { name = "username"; filename = None;
      content_type = Mime.text_plain;
      content = `String "alice" };
    { name = "avatar"; filename = Some "photo.jpg";
      content_type = Mime.jpeg;
      content = `File (Eio.Path.(fs / "photo.jpg")) }
  ]

content_type body returns the MIME type of the body, if set.

content_length body returns the content length in bytes, if known. Returns None for streaming bodies without a predetermined length.

Internal functions exposed for use by other modules in the library. These are not part of the public API and may change between versions.