mirror of
https://github.com/c-cube/sidekick.git
synced 2026-01-21 16:56:41 -05:00
2 lines
2 KiB
HTML
2 lines
2 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Decode (sidekick.Sidekick_bencode.Decode)</title><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc v2.3.0"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../odoc.support/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">sidekick</a> » <a href="../index.html">Sidekick_bencode</a> » Decode</nav><header class="odoc-preamble"><h1>Module <code><span>Sidekick_bencode.Decode</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-of_string"><a href="#val-of_string" class="anchor"></a><code><span><span class="keyword">val</span> of_string : <span><span class="optlabel">?idx</span>:int <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span>(int * <a href="../index.html#type-t">t</a>)</span> option</span></span></code></div><div class="spec-doc"><p>Decode string, and also return how many bytes were consumed.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">idx</span> <p>initial index (default 0)</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_string_exn"><a href="#val-of_string_exn" class="anchor"></a><code><span><span class="keyword">val</span> of_string_exn : <span><span class="optlabel">?idx</span>:int <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> int * <a href="../index.html#type-t">t</a></span></code></div><div class="spec-doc"><p>Parse string.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Error.Error</code> <p>if the string is not valid bencode.</p></li></ul></div></div></div></body></html>
|