mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-28 17:04:41 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
Nim/sha3.html
github-actions[bot] ef3d9e7b38 Deploy to GitHub pages
2025-12-28 15:55:52 +00:00

563 lines
51 KiB
HTML
Raw Permalink Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>src/checksums/sha3</title>
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">
<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">src/checksums/sha3</h1>
<div class="row">
<div class="three columns">
<div class="theme-select-wrapper">
<label for="theme-select">Theme:&nbsp;</label>
<select id="theme-select" onchange="setTheme(this.value)">
<option value="auto">🌗 Match OS</option>
<option value="dark">🌑 Dark</option>
<option value="light">🌕 Light</option>
</select>
</div>
<div id="global-links">
<ul class="simple-boot">
<li><a href="manual.html">Manual</a></li>
<li><a href="lib.html">Standard library</a></li>
<li> <a id="indexLink" href="theindex.html">Index</a></li>
<li><a href="compiler/theindex.html">Compiler docs</a></li>
<li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
<li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="search" id="searchInput"
oninput="search()" />
</div>
<ul class="simple simple-toc" id="toc-list">
<li><a class="reference" id="implemented-algorithms_toc" href="#implemented-algorithms">Implemented Algorithms</a></li>
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#Sha3Digest_224" title="Sha3Digest_224 = array[28, char]">Sha3Digest_224</a></li>
<li><a class="reference" href="#Sha3Digest_256" title="Sha3Digest_256 = array[32, char]">Sha3Digest_256</a></li>
<li><a class="reference" href="#Sha3Digest_384" title="Sha3Digest_384 = array[48, char]">Sha3Digest_384</a></li>
<li><a class="reference" href="#Sha3Digest_512" title="Sha3Digest_512 = array[64, char]">Sha3Digest_512</a></li>
<li><a class="reference" href="#Sha3Instance" title="Sha3Instance = enum
Sha3_224, ## SHA3-224 with an output size of 28 bytes
Sha3_256, ## SHA3-256 with an output size of 32 bytes
Sha3_384, ## SHA3-384 with an output size of 48 bytes
Sha3_512 ## SHA3-512 with an output size of 64 bytes">Sha3Instance</a></li>
<li><a class="reference" href="#Sha3State" title="Sha3State = distinct KeccakState">Sha3State</a></li>
<li><a class="reference" href="#Sha3StateStatic" title="Sha3StateStatic[instance] = distinct Sha3State">Sha3StateStatic</a></li>
<li><a class="reference" href="#ShakeInstance" title="ShakeInstance = enum
Shake128, ## Shake-128
Shake256, ## Shake-256
Shake512 ## Shake-512 (Keccak proposal; not officially included in SHA3)">ShakeInstance</a></li>
<li><a class="reference" href="#ShakeState" title="ShakeState = distinct KeccakState">ShakeState</a></li>
</ul>
</details>
</li>
<li>
<details open>
<summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">digest
<li><a class="reference" href="#digest%2CSha3State%2CopenArray%5Bchar%5D" title="digest(state: var Sha3State; dest: var openArray[char]): int">digest(state: var Sha3State; dest: var openArray[char]): int</a></li>
<li><a class="reference" href="#digest%2CSha3StateStatic%5BSha3Instance%5D" title="digest(state: var Sha3StateStatic[Sha3_224]): Sha3Digest_224">digest(state: var Sha3StateStatic[Sha3_224]): Sha3Digest_224</a></li>
<li><a class="reference" href="#digest%2CSha3StateStatic%5BSha3Instance%5D_2" title="digest(state: var Sha3StateStatic[Sha3_256]): Sha3Digest_256">digest(state: var Sha3StateStatic[Sha3_256]): Sha3Digest_256</a></li>
<li><a class="reference" href="#digest%2CSha3StateStatic%5BSha3Instance%5D_3" title="digest(state: var Sha3StateStatic[Sha3_384]): Sha3Digest_384">digest(state: var Sha3StateStatic[Sha3_384]): Sha3Digest_384</a></li>
<li><a class="reference" href="#digest%2CSha3StateStatic%5BSha3Instance%5D_4" title="digest(state: var Sha3StateStatic[Sha3_512]): Sha3Digest_512">digest(state: var Sha3StateStatic[Sha3_512]): Sha3Digest_512</a></li>
</ul>
<ul class="simple nested-toc-section">digestLength
<li><a class="reference" href="#digestLength%2CSha3Instance" title="digestLength(instance: Sha3Instance): int">digestLength(instance: Sha3Instance): int</a></li>
<li><a class="reference" href="#digestLength%2CShakeInstance" title="digestLength(instance: ShakeInstance): int">digestLength(instance: ShakeInstance): int</a></li>
</ul>
<ul class="simple nested-toc-section">finalize
<li><a class="reference" href="#finalize%2CShakeState" title="finalize(state: var ShakeState)">finalize(state: var ShakeState)</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3
<li><a class="reference" href="#initSha3%2CSha3Instance" title="initSha3(instance: Sha3Instance): Sha3State">initSha3(instance: Sha3Instance): Sha3State</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3_224
<li><a class="reference" href="#initSha3_224" title="initSha3_224(): Sha3StateStatic[Sha3_224]">initSha3_224(): Sha3StateStatic[Sha3_224]</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3_256
<li><a class="reference" href="#initSha3_256" title="initSha3_256(): Sha3StateStatic[Sha3_256]">initSha3_256(): Sha3StateStatic[Sha3_256]</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3_384
<li><a class="reference" href="#initSha3_384" title="initSha3_384(): Sha3StateStatic[Sha3_384]">initSha3_384(): Sha3StateStatic[Sha3_384]</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3_512
<li><a class="reference" href="#initSha3_512" title="initSha3_512(): Sha3StateStatic[Sha3_512]">initSha3_512(): Sha3StateStatic[Sha3_512]</a></li>
</ul>
<ul class="simple nested-toc-section">initSha3StateStatic
<li><a class="reference" href="#initSha3StateStatic%2CstaticSha3Instance" title="initSha3StateStatic(instance: static Sha3Instance): Sha3StateStatic[instance]">initSha3StateStatic(instance: static Sha3Instance): Sha3StateStatic[instance]</a></li>
</ul>
<ul class="simple nested-toc-section">initShake
<li><a class="reference" href="#initShake%2CShakeInstance" title="initShake(instance: ShakeInstance): ShakeState">initShake(instance: ShakeInstance): ShakeState</a></li>
</ul>
<ul class="simple nested-toc-section">secureHash
<li><a class="reference" href="#secureHash%2CSha3Instance%2CopenArray%5Bchar%5D" title="secureHash(instance: Sha3Instance; data: openArray[char]): seq[char]">secureHash(instance: Sha3Instance; data: openArray[char]): seq[char]</a></li>
<li><a class="reference" href="#secureHash%2CstaticSha3Instance%2CopenArray%5Bchar%5D" title="secureHash(instance: static Sha3Instance; data: openArray[char]): auto">secureHash(instance: static Sha3Instance; data: openArray[char]): auto</a></li>
</ul>
<ul class="simple nested-toc-section">shakeOut
<li><a class="reference" href="#shakeOut%2CShakeState%2CopenArray%5Bchar%5D" title="shakeOut(state: var ShakeState; dest: var openArray[char])">shakeOut(state: var ShakeState; dest: var openArray[char])</a></li>
</ul>
<ul class="simple nested-toc-section">update
<li><a class="reference" href="#update%2CSha3State%2CopenArray%5Bchar%5D" title="update(state: var Sha3State; data: openArray[char])">update(state: var Sha3State; data: openArray[char])</a></li>
<li><a class="reference" href="#update%2CShakeState%2CopenArray%5Bchar%5D" title="update(state: var ShakeState; data: openArray[char])">update(state: var ShakeState; data: openArray[char])</a></li>
<li><a class="reference" href="#update%2CSha3StateStatic%5Binstance%5D%2CopenArray%5Bchar%5D" title="update[instance: static Sha3Instance](state: var Sha3StateStatic[instance];
data: openArray[char])">update[instance: static Sha3Instance](state: var Sha3StateStatic[instance];
data: openArray[char])</a></li>
</ul>
</ul>
</details>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc"><p><a class="reference external" href="https://en.wikipedia.org/wiki/SHA-3">SHA-3 (Secure Hash Algorithm 3)</a> is a cryptographic hash function which takes an input and produces a value known as a message digest.</p>
<p>It provides both fixed size algorithms that generate a one-shot message digest of a determinate size as well as an <em>extendable-output function</em> (XOF) variant that can produce any message digest lengths desired.</p>
<h1><a class="toc-backref" id="implemented-algorithms" href="#implemented-algorithms">Implemented Algorithms</a></h1><p>Fixed size functions:</p>
<ul class="simple"><li>SHA3-224</li>
<li>SHA3-256</li>
<li>SHA3-384</li>
<li>SHA3-512</li>
</ul>
<p>Extended-output functions:</p>
<ul class="simple"><li>SHAKE128</li>
<li>SHAKE256</li>
<li>SHAKE512</li>
</ul>
<p>For convenience, this module provides output-length type checked functions for the implemented fixed size functions via <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha3_224</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha3_256</span></span></tt>, <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha3_384</span></span></tt> and <tt class="docutils literal"><span class="pre"><span class="Identifier">initSha3_512</span></span></tt>. These functions provide a <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> overload returning a correctly sized message digest array.</p>
<p>If more relaxed types are required, an &quot;unchecked&quot; <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha3State</span></span></tt> can be used, but care must be taken to provide <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> with a correctly sized <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> array. </p>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">src</span><span class="Operator">/</span><span class="Identifier">checksums</span><span class="Operator">/</span><span class="Identifier">sha3</span>
<span class="Keyword">var</span> <span class="Identifier">hasher</span> <span class="Operator">=</span> <span class="Identifier">initSha3_256</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;The quick brown fox &quot;</span><span class="Punctuation">)</span>
<span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;jumps over the lazy dog&quot;</span><span class="Punctuation">)</span>
<span class="Keyword">let</span> <span class="Identifier">digest</span> <span class="Operator">=</span> <span class="Identifier">hasher</span><span class="Operator">.</span><span class="Identifier">digest</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">digest</span> <span class="Operator">==</span> <span class="StringLit">&quot;69070dda01975c8c120c3aada1b282394e7f032fa9cf32f4cb2259a0897dfc04&quot;</span></pre>
<p><strong class="examples_text">Example:</strong></p>
<pre class="listing"><span class="Keyword">import</span> <span class="Identifier">src</span><span class="Operator">/</span><span class="Identifier">checksums</span><span class="Operator">/</span><span class="Identifier">sha3</span>
<span class="Keyword">var</span> <span class="Identifier">xof</span> <span class="Operator">=</span> <span class="Identifier">initShake</span><span class="Punctuation">(</span><span class="Identifier">Shake128</span><span class="Punctuation">)</span>
<span class="Identifier">xof</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;The quick brown fox &quot;</span><span class="Punctuation">)</span>
<span class="Identifier">xof</span><span class="Operator">.</span><span class="Identifier">update</span><span class="Punctuation">(</span><span class="StringLit">&quot;jumps over the lazy dog&quot;</span><span class="Punctuation">)</span>
<span class="Identifier">xof</span><span class="Operator">.</span><span class="Identifier">finalize</span><span class="Punctuation">(</span><span class="Punctuation">)</span>
<span class="Keyword">var</span> <span class="Identifier">digest</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">16</span><span class="Punctuation">,</span> <span class="Identifier">char</span><span class="Punctuation">]</span>
<span class="Identifier">xof</span><span class="Operator">.</span><span class="Identifier">shakeOut</span><span class="Punctuation">(</span><span class="Identifier">digest</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">digest</span> <span class="Operator">==</span> <span class="StringLit">&quot;f4202e3c5852f9182a0430fd8144f0a7&quot;</span>
<span class="Identifier">xof</span><span class="Operator">.</span><span class="Identifier">shakeOut</span><span class="Punctuation">(</span><span class="Identifier">digest</span><span class="Punctuation">)</span>
<span class="Identifier">assert</span> <span class="Operator">$</span><span class="Identifier">digest</span> <span class="Operator">==</span> <span class="StringLit">&quot;4b95e7417ecae17db0f8cfeed0e3e66e&quot;</span></pre></p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="sha_utils.html">sha_utils</a>
</dl>
</div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="Sha3Digest_224">
<dt><pre><a href="sha3.html#Sha3Digest_224"><span class="Identifier">Sha3Digest_224</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">28</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
<dd>
SHA3-224 output digest.
</dd>
</div>
<div id="Sha3Digest_256">
<dt><pre><a href="sha3.html#Sha3Digest_256"><span class="Identifier">Sha3Digest_256</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">32</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
<dd>
SHA3-256 output digest.
</dd>
</div>
<div id="Sha3Digest_384">
<dt><pre><a href="sha3.html#Sha3Digest_384"><span class="Identifier">Sha3Digest_384</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">48</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
<dd>
SHA3-384 output digest.
</dd>
</div>
<div id="Sha3Digest_512">
<dt><pre><a href="sha3.html#Sha3Digest_512"><span class="Identifier">Sha3Digest_512</span></a> <span class="Other">=</span> <span class="Identifier">array</span><span class="Other">[</span><span class="DecNumber">64</span><span class="Other">,</span> <span class="Identifier">char</span><span class="Other">]</span></pre></dt>
<dd>
SHA3-512 output digest.
</dd>
</div>
<div id="Sha3Instance">
<dt><pre><a href="sha3.html#Sha3Instance"><span class="Identifier">Sha3Instance</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Sha3_224</span><span class="Other">,</span> <span class="Comment">## SHA3-224 with an output size of 28 bytes</span>
<span class="Identifier">Sha3_256</span><span class="Other">,</span> <span class="Comment">## SHA3-256 with an output size of 32 bytes</span>
<span class="Identifier">Sha3_384</span><span class="Other">,</span> <span class="Comment">## SHA3-384 with an output size of 48 bytes</span>
<span class="Identifier">Sha3_512</span> <span class="Comment">## SHA3-512 with an output size of 64 bytes</span></pre></dt>
<dd>
Selects a specific SHA3 instance with well known message digest lengths and properties.
</dd>
</div>
<div id="Sha3State">
<dt><pre><a href="sha3.html#Sha3State"><span class="Identifier">Sha3State</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">KeccakState</span></pre></dt>
<dd>
<p>An unchecked SHA3 state created from a specific <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha3Instance</span></span></tt>.</p>
<p>Unchecked meaning the user has to make sure that the target buffer has enough room to store the resulting digest, otherwise <tt class="docutils literal"><span class="pre"><span class="Identifier">digest</span></span></tt> will truncate the output.</p>
</dd>
</div>
<div id="Sha3StateStatic">
<dt><pre><a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">distinct</span> <a href="sha3.html#Sha3State"><span class="Identifier">Sha3State</span></a></pre></dt>
<dd>
A statically checked SHA3 state created from a specific <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha3Instance</span></span></tt>.
</dd>
</div>
<div id="ShakeInstance">
<dt><pre><a href="sha3.html#ShakeInstance"><span class="Identifier">ShakeInstance</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">Shake128</span><span class="Other">,</span> <span class="Comment">## Shake-128</span>
<span class="Identifier">Shake256</span><span class="Other">,</span> <span class="Comment">## Shake-256</span>
<span class="Identifier">Shake512</span> <span class="Comment">## Shake-512 (Keccak proposal; not officially included in SHA3)</span></pre></dt>
<dd>
Selects a specific Shake instance with well known properties.
</dd>
</div>
<div id="ShakeState">
<dt><pre><a href="sha3.html#ShakeState"><span class="Identifier">ShakeState</span></a> <span class="Other">=</span> <span class="Keyword">distinct</span> <span class="Identifier">KeccakState</span></pre></dt>
<dd>
A Shake state created from a specific <tt class="docutils literal"><span class="pre"><span class="Identifier">ShakeInstance</span></span></tt>.
</dd>
</div>
</dl>
</div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="digest-procs-all">
<div id="digest,Sha3State,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2CSha3State%2CopenArray%5Bchar%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3State"><span class="Identifier">Sha3State</span></a><span class="Other">;</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Finishes, stores the completed message digest in <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> and returns the number of bytes written in <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt>.</p>
<p>If <tt class="docutils literal"><span class="pre"><span class="Identifier">dest</span></span></tt> is not big enough to contain the digest produced by the selected instance, everything that would overflow is truncated.</p>
</dd>
</div>
<div id="digest,Sha3StateStatic[Sha3Instance]">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2CSha3StateStatic%5BSha3Instance%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_224</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3Digest_224"><span class="Identifier">Sha3Digest_224</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Finishes and returns the completed SHA3-224 message digest.
</dd>
</div>
<div id="digest,Sha3StateStatic[Sha3Instance]_2">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2CSha3StateStatic%5BSha3Instance%5D_2"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_256</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3Digest_256"><span class="Identifier">Sha3Digest_256</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Finishes and returns the completed SHA3-256 message digest.
</dd>
</div>
<div id="digest,Sha3StateStatic[Sha3Instance]_3">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2CSha3StateStatic%5BSha3Instance%5D_3"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_384</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3Digest_384"><span class="Identifier">Sha3Digest_384</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Finishes and returns the completed SHA3-284 message digest.
</dd>
</div>
<div id="digest,Sha3StateStatic[Sha3Instance]_4">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2CSha3StateStatic%5BSha3Instance%5D_4"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_512</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3Digest_512"><span class="Identifier">Sha3Digest_512</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Finishes and returns the completed SHA3-512 message digest.
</dd>
</div>
</div>
<div id="digestLength-procs-all">
<div id="digestLength,Sha3Instance">
<dt><pre><span class="Keyword">func</span> <a href="#digestLength%2CSha3Instance"><span class="Identifier">digestLength</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha3.html#Sha3Instance"><span class="Identifier">Sha3Instance</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Returns the message digest size for the selected SHA3 instance.
</dd>
</div>
<div id="digestLength,ShakeInstance">
<dt><pre><span class="Keyword">func</span> <a href="#digestLength%2CShakeInstance"><span class="Identifier">digestLength</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha3.html#ShakeInstance"><span class="Identifier">ShakeInstance</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Returns the message digest size for the selected Shake instance.
</dd>
</div>
</div>
<div id="finalize-procs-all">
<div id="finalize,ShakeState">
<dt><pre><span class="Keyword">proc</span> <a href="#finalize%2CShakeState"><span class="Identifier">finalize</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#ShakeState"><span class="Identifier">ShakeState</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Finishes the input digestion state of the given <tt class="docutils literal"><span class="pre"><span class="Identifier">ShakeState</span></span></tt> and readies it for message digest retrieval.
</dd>
</div>
</div>
<div id="initSha3-procs-all">
<div id="initSha3,Sha3Instance">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3%2CSha3Instance"><span class="Identifier">initSha3</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha3.html#Sha3Instance"><span class="Identifier">Sha3Instance</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3State"><span class="Identifier">Sha3State</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new unchecked SHA3 state for the selected instance <tt class="docutils literal"><span class="pre"><span class="Identifier">instance</span></span></tt>.
</dd>
</div>
</div>
<div id="initSha3_224-procs-all">
<div id="initSha3_224">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3_224"><span class="Identifier">initSha3_224</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_224</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new statically checked state for the SHA3-224 instance.
</dd>
</div>
</div>
<div id="initSha3_256-procs-all">
<div id="initSha3_256">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3_256"><span class="Identifier">initSha3_256</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_256</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new statically checked state for the SHA3-256 instance.
</dd>
</div>
</div>
<div id="initSha3_384-procs-all">
<div id="initSha3_384">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3_384"><span class="Identifier">initSha3_384</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_384</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new statically checked state for the SHA3-384 instance.
</dd>
</div>
</div>
<div id="initSha3_512-procs-all">
<div id="initSha3_512">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3_512"><span class="Identifier">initSha3_512</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">Sha3_512</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new statically checked state for the SHA3-512 instance.
</dd>
</div>
</div>
<div id="initSha3StateStatic-procs-all">
<div id="initSha3StateStatic,staticSha3Instance">
<dt><pre><span class="Keyword">func</span> <a href="#initSha3StateStatic%2CstaticSha3Instance"><span class="Identifier">initSha3StateStatic</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">Sha3Instance</span><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span>
<span class="Identifier">instance</span><span class="Other">]</span></pre></dt>
<dd>
Constructs a new statically checked SHA3 state for the selected instance <tt class="docutils literal"><span class="pre"><span class="Identifier">instance</span></span></tt>.
</dd>
</div>
</div>
<div id="initShake-procs-all">
<div id="initShake,ShakeInstance">
<dt><pre><span class="Keyword">func</span> <a href="#initShake%2CShakeInstance"><span class="Identifier">initShake</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha3.html#ShakeInstance"><span class="Identifier">ShakeInstance</span></a><span class="Other">)</span><span class="Other">:</span> <a href="sha3.html#ShakeState"><span class="Identifier">ShakeState</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Constructs a new Shake state for the selected instance <tt class="docutils literal"><span class="pre"><span class="Identifier">instance</span></span></tt>.
</dd>
</div>
</div>
<div id="secureHash-procs-all">
<div id="secureHash,Sha3Instance,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#secureHash%2CSha3Instance%2CopenArray%5Bchar%5D"><span class="Identifier">secureHash</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <a href="sha3.html#Sha3Instance"><span class="Identifier">Sha3Instance</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Convenience wrapper around the standard &quot;init, update, digest&quot; sequence with a runtime selected SHA instance.
</dd>
</div>
<div id="secureHash,staticSha3Instance,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#secureHash%2CstaticSha3Instance%2CopenArray%5Bchar%5D"><span class="Identifier">secureHash</span></a><span class="Other">(</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">Sha3Instance</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</span></pre></dt>
<dd>
Convenience wrapper around the standard &quot;init, update, digest&quot; sequence with a statically selected SHA instance.
</dd>
</div>
</div>
<div id="shakeOut-procs-all">
<div id="shakeOut,ShakeState,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#shakeOut%2CShakeState%2CopenArray%5Bchar%5D"><span class="Identifier">shakeOut</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#ShakeState"><span class="Identifier">ShakeState</span></a><span class="Other">;</span> <span class="Identifier">dest</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>&quot;Shakes out&quot; a part of the variable length Shake message digest. The <tt class="docutils literal"><span class="pre"><span class="Identifier">ShakeState</span></span></tt> must be <tt class="docutils literal"><span class="pre"><span class="Identifier">finalize</span></span></tt>d before calling this procedure.</p>
<p>It can be invoked multiple times with user selectable buffer sizes. In particular, it is guaranteed that the same digest is extracted in both of the following examples, given the same <tt class="docutils literal"><span class="pre"><span class="Identifier">state</span></span></tt>:</p>
<p><pre class="listing"> <span class="Keyword">var</span> <span class="Identifier">digest</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">32</span><span class="Punctuation">,</span> <span class="Identifier">byte</span><span class="Punctuation">]</span>
<span class="Identifier">state</span><span class="Operator">.</span><span class="Identifier">shakeOut</span><span class="Punctuation">(</span><span class="Identifier">digestPart</span><span class="Punctuation">)</span></pre></p>
<p><pre class="listing"> <span class="Keyword">var</span> <span class="Identifier">digestA</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">16</span><span class="Punctuation">,</span> <span class="Identifier">byte</span><span class="Punctuation">]</span>
<span class="Keyword">var</span> <span class="Identifier">digestB</span><span class="Punctuation">:</span> <span class="Identifier">array</span><span class="Punctuation">[</span><span class="DecNumber">16</span><span class="Punctuation">,</span> <span class="Identifier">byte</span><span class="Punctuation">]</span>
<span class="Identifier">state</span><span class="Operator">.</span><span class="Identifier">shakeOut</span><span class="Punctuation">(</span><span class="Identifier">digestA</span><span class="Punctuation">)</span>
<span class="Identifier">state</span><span class="Operator">.</span><span class="Identifier">shakeOut</span><span class="Punctuation">(</span><span class="Identifier">digestB</span><span class="Punctuation">)</span></pre></p>
</dd>
</div>
</div>
<div id="update-procs-all">
<div id="update,Sha3State,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#update%2CSha3State%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3State"><span class="Identifier">Sha3State</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">borrow</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Updates the given <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha3State</span></span></tt> with the provided buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.
</dd>
</div>
<div id="update,ShakeState,openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#update%2CShakeState%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#ShakeState"><span class="Identifier">ShakeState</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span> {.<span class="Identifier">borrow</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Updates the given <tt class="docutils literal"><span class="pre"><span class="Identifier">ShakeState</span></span></tt> with the provided buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.
</dd>
</div>
<div id="update,Sha3StateStatic[instance],openArray[char]">
<dt><pre><span class="Keyword">proc</span> <a href="#update%2CSha3StateStatic%5Binstance%5D%2CopenArray%5Bchar%5D"><span class="Identifier">update</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">:</span> <span class="Identifier">static</span> <span class="Identifier">Sha3Instance</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">state</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="sha3.html#Sha3StateStatic"><span class="Identifier">Sha3StateStatic</span></a><span class="Other">[</span><span class="Identifier">instance</span><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">char</span><span class="Other">]</span><span class="Other">)</span></pre></dt>
<dd>
Updates the given <tt class="docutils literal"><span class="pre"><span class="Identifier">Sha3StateStatic</span></span></tt> with the provided buffer <tt class="docutils literal"><span class="pre"><span class="Identifier">data</span></span></tt>.
</dd>
</div>
</div>
</dl>
</div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="sha_utils.html#$,array[n,char]"><span class="Identifier">$</span></a>
</dl>
</div>
</div>
</div>
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br>
<small style="color: var(--hint);">Made with Nim. Generated: 2025-12-28 15:55:39 UTC</small>
</div>
</div>
</div>
<script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink