mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-05-06 09:24:31 -04:00
2 lines
3.8 KiB
HTML
2 lines
3.8 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Decode (containers.Containers_leb128.Decode)</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> » <a href="../../index.html">containers</a> » <a href="../index.html">Containers_leb128</a> » Decode</nav><header class="odoc-preamble"><h1>Module <code><span>Containers_leb128.Decode</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-decode_zigzag"><a href="#val-decode_zigzag" class="anchor"></a><code><span><span class="keyword">val</span> decode_zigzag : <span>int64 <span class="arrow">-></span></span> int64</span></code></div><div class="spec-doc"><p>Turn an unsigned integer into a signed one.</p><p>See https://en.wikipedia.org/wiki/Variable-length_quantity#Zigzag_encoding</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-skip"><a href="#val-skip" class="anchor"></a><code><span><span class="keyword">val</span> skip : <span><a href="../../CCByte_slice/index.html#type-t">Byte_slice.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int</span></code></div><div class="spec-doc"><p><code>skip slice off</code> reads an integer at offset <code>off</code>, and returns how many bytes the integer occupies.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-u64"><a href="#val-u64" class="anchor"></a><code><span><span class="keyword">val</span> u64 : <span><a href="../../CCByte_slice/index.html#type-t">Byte_slice.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int64 * int</span></code></div><div class="spec-doc"><p><code>u64 slice off</code> reads an integer at offset <code>off</code>, and returns a pair <code>v, n_consumed</code>. <code>v</code> is the read integer, <code>n_consumed</code> is the number of bytes consumed during reading.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-i64"><a href="#val-i64" class="anchor"></a><code><span><span class="keyword">val</span> i64 : <span><a href="../../CCByte_slice/index.html#type-t">Byte_slice.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int64 * int</span></code></div><div class="spec-doc"><p>Read a signed int64 by reading a u64 and zigzag decoding it</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-int_truncate"><a href="#val-int_truncate" class="anchor"></a><code><span><span class="keyword">val</span> int_truncate : <span><a href="../../CCByte_slice/index.html#type-t">Byte_slice.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int * int</span></code></div><div class="spec-doc"><p>Like <a href="#val-i64"><code>i64</code></a> but truncates to integer. Returns a pair <code>v, n_consumed</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-uint_truncate"><a href="#val-uint_truncate" class="anchor"></a><code><span><span class="keyword">val</span> uint_truncate : <span><a href="../../CCByte_slice/index.html#type-t">Byte_slice.t</a> <span class="arrow">-></span></span> <span>int <span class="arrow">-></span></span> int * int</span></code></div><div class="spec-doc"><p>Like <a href="#val-u64"><code>u64</code></a> but truncates to integer.</p></div></div></div></body></html>
|