mirror of
https://github.com/c-cube/linol.git
synced 2025-12-06 11:15:46 -05:00
2 lines
3.1 KiB
HTML
2 lines
3.1 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Manual (uutf.Uutf.Manual)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../_odoc-theme/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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">uutf</a> » <a href="../index.html">Uutf</a> » Manual</nav><header class="odoc-preamble"><h1>Module <code><span>Uutf.Manual</span></code></h1><p>Manual sources and destinations.</p><p><b>Warning.</b> Use only with <code>`Manual</code> decoder and encoders.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-src"><a href="#val-src" class="anchor"></a><code><span><span class="keyword">val</span> src : <span><a href="../index.html#type-decoder">decoder</a> <span class="arrow">-></span></span> <span><a href="../../../ocaml/Stdlib/Bytes/index.html#type-t">Stdlib.Bytes.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>src d s j l</code> provides <code>d</code> with <code>l</code> bytes to read, starting at <code>j</code> in <code>s</code>. This byte range is read by calls to <a href="../index.html#val-decode"><code>decode</code></a> with <code>d</code> until <code>`Await</code> is returned. To signal the end of input call the function with <code>l = 0</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dst"><a href="#val-dst" class="anchor"></a><code><span><span class="keyword">val</span> dst : <span><a href="../index.html#type-encoder">encoder</a> <span class="arrow">-></span></span> <span><a href="../../../ocaml/Stdlib/Bytes/index.html#type-t">Stdlib.Bytes.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p><code>dst e s j l</code> provides <code>e</code> with <code>l</code> bytes to write, starting at <code>j</code> in <code>s</code>. This byte range is written by calls to <a href="../index.html#val-encode"><code>encode</code></a> with <code>e</code> until <code>`Partial</code> is returned. Use <a href="#val-dst_rem"><code>dst_rem</code></a> to know the remaining number of non-written free bytes in <code>s</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dst_rem"><a href="#val-dst_rem" class="anchor"></a><code><span><span class="keyword">val</span> dst_rem : <span><a href="../index.html#type-encoder">encoder</a> <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>dst_rem e</code> is the remaining number of non-written, free bytes in the last buffer provided with <a href="#val-dst"><code>Manual.dst</code></a>.</p></div></div></div></body></html>
|