package cohttp

  1. Overview
  2. Docs

Module Cohttp.TransferSource

Read and write the HTTP/1.1 transfer-encoding formats. Currently supported are chunked and content-length.

Sourcetype encoding =
  1. | Chunked
    (*

    dynamic chunked encoding

    *)
  2. | Fixed of int64
    (*

    fixed size content

    *)
  3. | Unknown
    (*

    unknown body size, which leads to best-effort

    *)

The encoding format detected from the transfer-encoding and content-length headers

Sourceval sexp_of_encoding : encoding -> Sexplib0.Sexp.t
Sourceval encoding_of_sexp : Sexplib0.Sexp.t -> encoding
Sourcetype chunk =
  1. | Chunk of string
    (*

    chunk of data and not the end of stream

    *)
  2. | Final_chunk of string
    (*

    the last chunk of data, so no more should be read

    *)
  3. | Done
    (*

    no more body data is present

    *)

A chunk of body that also signals if there to more to arrive

Sourceval sexp_of_chunk : chunk -> Sexplib0.Sexp.t
Sourceval chunk_of_sexp : Sexplib0.Sexp.t -> chunk
Sourceval string_of_encoding : encoding -> string

Convert the encoding format to a human-readable string

Sourceval has_body : encoding -> [ `No | `Unknown | `Yes ]

has_body encoding returns the appropriate variant that indicates whether the HTTP request or response has an associated body. It does not guess: instead Unknown is returned if there is no explicit association.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct