Compression(3)

πŸ’… NAME πŸ’…

Okay bestie, welcome to Compression(3) from the OCaml library. The NAME section is serving us Compression - no description, and honestly that's the whole description β€” iconic minimalism, no cap πŸ™ˆβœ¨.


🧚 MODULE 🧚

Top-level module: Module Compression. That's the module vibe check 🫢.


✨ DOCUMENTATION ✨

The docs open with the module signature block, and yes, she is minimal:

Module Compression
 : sig end

Now for the values β€” every signature is staying exactly as it is, bestie πŸ’–:

  • val output_value : out_channel -> 'a -> unit β€” Compression.output_value chan v writes the representation of v to channel chan. If compression is supported, the marshaled data representing value v is compressed before it's written to channel chan. If compression is not supported, this function behaves like output_value. Slay, but make it bytes πŸ”₯.
  • val input_value : in_channel -> 'a β€” Compression.input_value chan reads from channel chan the byte representation of a structured value, as produced by Compression.output_value, and reconstructs and returns the corresponding value. If compression is not supported, this function behaves like input_value. It's giving read-and-rebuild realness πŸ˜­πŸ’….
  • val compression_supported : bool β€” reports whether compression is supported. That's it, that's the whole value β€” a little bool doing main character energy ⭐.

This iconic page was brought to you by OCamldoc, dated 2026-06-22, signing off from Compression(3) β€” byeee bestie, stay compressed only when supported πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from