moonpool/ocaml/Compression/index.html
2025-09-26 19:08:06 +00:00

2 lines
2.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Compression (ocaml.Compression)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 3.1.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> <a href="../../index.html">Index</a> &#x00BB; <a href="../index.html">ocaml</a> &#x00BB; Compression</nav><header class="odoc-preamble"><h1>Module <code><span>Compression</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-output_value"><a href="#val-output_value" class="anchor"></a><code><span><span class="keyword">val</span> output_value : <span><a href="../Stdlib/index.html#type-out_channel">out_channel</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p><code>Compression.output_value chan v</code> writes the representation of <code>v</code> on channel <code>chan</code>. If compression is supported, the marshaled data representing value <code>v</code> is compressed before being written to channel <code>chan</code>. If compression is not supported, this function behaves like <a href="../Stdlib/index.html#val-output_value"><code>Stdlib.output_value</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-input_value"><a href="#val-input_value" class="anchor"></a><code><span><span class="keyword">val</span> input_value : <span><a href="../Stdlib/index.html#type-in_channel">in_channel</a> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p><code>Compression.input_value chan</code> reads from channel <code>chan</code> the byte representation of a structured value, as produced by <code>Compression.output_value</code>, and reconstructs and returns the corresponding value. If compression is not supported, this function behaves like <a href="../Stdlib/index.html#val-input_value"><code>Stdlib.input_value</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-compression_supported"><a href="#val-compression_supported" class="anchor"></a><code><span><span class="keyword">val</span> compression_supported : bool</span></code></div><div class="spec-doc"><p>Reports whether compression is supported.</p></div></div></div></body></html>