status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-libp2p/remove-secio/libp2p/multihash.html

700 lines
53 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- 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=">
<!-- 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'/>
<!-- CSS -->
<title>libp2p/multihash</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
<script type="text/javascript" src="../dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
if (toggleSwitch !== null) {
toggleSwitch.addEventListener('change', switchTheme, false);
}
var currentTheme = localStorage.getItem('theme');
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
currentTheme = 'dark';
}
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark' && toggleSwitch !== null) {
toggleSwitch.checked = true;
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">libp2p/multihash</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#MHash"
title="MHash = object
mcodec*: MultiCodec
size*: int
coder*: MHashCoderProc">MHash</a></li>
<li><a class="reference" href="#MHashCoderProc"
title="MHashCoderProc = proc (data: openArray[byte]; output: var openArray[byte]) {.
nimcall, gcsafe, noSideEffect, raises: [].}">MHashCoderProc</a></li>
<li><a class="reference" href="#MhResult"
title="MhResult[T] = Result[T, cstring]">MhResult</a></li>
<li><a class="reference" href="#MultiHash"
title="MultiHash = object
data*: VBuffer
mcodec*: MultiCodec
size*: int
dpos*: int">MultiHash</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#MaxHashSize"
title="MaxHashSize = 128">MaxHashSize</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">$
<li><a class="reference" href="#%24%2CMultiHash"
title="`$`(mh: MultiHash): string">`$`(mh: MultiHash): string</a></li>
</ul>
<ul class="simple nested-toc-section">==
<li><a class="reference" href="#%3D%3D%2CMultiHash%2CMultiHash"
title="`==`(a: MultiHash; b: MultiHash): bool">`==`(a: MultiHash; b: MultiHash): bool</a></li>
<li><a class="reference" href="#%3D%3D%2CMDigest%5BT%5D%2CMultiHash"
title="`==`[T](mdigest: MDigest[T]; mh: MultiHash): bool">`==`[T](mdigest: MDigest[T]; mh: MultiHash): bool</a></li>
<li><a class="reference" href="#%3D%3D%2CMultiHash%2CMDigest%5BT%5D"
title="`==`[T](mh: MultiHash; mdigest: MDigest[T]): bool">`==`[T](mh: MultiHash; mdigest: MDigest[T]): bool</a></li>
</ul>
<ul class="simple nested-toc-section">base58
<li><a class="reference" href="#base58%2CMultiHash"
title="base58(value: MultiHash): string">base58(value: MultiHash): string</a></li>
</ul>
<ul class="simple nested-toc-section">decode
<li><a class="reference" href="#decode%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D%2CMultiHash"
title="decode(mhtype: typedesc[MultiHash]; data: openArray[byte]; mhash: var MultiHash): MhResult[
int]">decode(mhtype: typedesc[MultiHash]; data: openArray[byte]; mhash: var MultiHash): MhResult[
int]</a></li>
</ul>
<ul class="simple nested-toc-section">digest
<li><a class="reference" href="#digest%2Ctypedesc%5BMultiHash%5D%2Cint%2CopenArray%5Bbyte%5D"
title="digest(mhtype: typedesc[MultiHash]; hashcode: int; data: openArray[byte]): MhResult[
MultiHash]">digest(mhtype: typedesc[MultiHash]; hashcode: int; data: openArray[byte]): MhResult[
MultiHash]</a></li>
<li><a class="reference" href="#digest%2Ctypedesc%5BMultiHash%5D%2Cstring%2CopenArray%5Bbyte%5D"
title="digest(mhtype: typedesc[MultiHash]; hashname: string; data: openArray[byte]): MhResult[
MultiHash]">digest(mhtype: typedesc[MultiHash]; hashname: string; data: openArray[byte]): MhResult[
MultiHash]</a></li>
</ul>
<ul class="simple nested-toc-section">encode
<li><a class="reference" href="#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CMultiHash"
title="encode(mbtype: typedesc[MultiBase]; encoding: string; mh: MultiHash): string">encode(mbtype: typedesc[MultiBase]; encoding: string; mh: MultiHash): string</a></li>
</ul>
<ul class="simple nested-toc-section">hex
<li><a class="reference" href="#hex%2CMultiHash"
title="hex(value: MultiHash): string">hex(value: MultiHash): string</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D"
title="init(mhtype: typedesc[MultiHash]; data: openArray[byte]): MhResult[MultiHash]">init(mhtype: typedesc[MultiHash]; data: openArray[byte]): MhResult[MultiHash]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring"
title="init(mhtype: typedesc[MultiHash]; data: string): MhResult[MultiHash]">init(mhtype: typedesc[MultiHash]; data: string): MhResult[MultiHash]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2CMultiCodec%2CopenArray%5Bbyte%5D"
title="init(mhtype: typedesc[MultiHash]; hashcode: MultiCodec; bdigest: openArray[byte]): MhResult[
MultiHash]">init(mhtype: typedesc[MultiHash]; hashcode: MultiCodec; bdigest: openArray[byte]): MhResult[
MultiHash]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring%2CopenArray%5Bbyte%5D"
title="init(mhtype: typedesc[MultiHash]; hashname: string; bdigest: openArray[byte]): MhResult[
MultiHash]">init(mhtype: typedesc[MultiHash]; hashname: string; bdigest: openArray[byte]): MhResult[
MultiHash]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2CMultiCodec%2CMDigest%5BT%5D"
title="init[T](mhtype: typedesc[MultiHash]; hashcode: MultiCodec; mdigest: MDigest[T]): MhResult[
MultiHash]">init[T](mhtype: typedesc[MultiHash]; hashcode: MultiCodec; mdigest: MDigest[T]): MhResult[
MultiHash]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring%2CMDigest%5BT%5D"
title="init[T](mhtype: typedesc[MultiHash]; hashname: string; mdigest: MDigest[T]): MhResult[
MultiHash]">init[T](mhtype: typedesc[MultiHash]; hashname: string; mdigest: MDigest[T]): MhResult[
MultiHash]</a></li>
</ul>
<ul class="simple nested-toc-section">init58
<li><a class="reference" href="#init58%2Ctypedesc%5BMultiHash%5D%2Cstring"
title="init58(mhtype: typedesc[MultiHash]; data: string): MultiHash">init58(mhtype: typedesc[MultiHash]; data: string): MultiHash</a></li>
</ul>
<ul class="simple nested-toc-section">validate
<li><a class="reference" href="#validate%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D"
title="validate(mhtype: typedesc[MultiHash]; data: openArray[byte]): bool">validate(mhtype: typedesc[MultiHash]; data: openArray[byte]): bool</a></li>
</ul>
<ul class="simple nested-toc-section">write
<li><a class="reference" href="#write%2CVBuffer%2CMultiHash"
title="write(vb: var VBuffer; mh: MultiHash)">write(vb: var VBuffer; mh: MultiHash)</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">This module implements MultiHash. Supported hashes are:<ol class="simple"><li>IDENTITY</li>
<li>SHA2-256/SHA2-512</li>
<li>DBL-SHA2-256</li>
<li>SHA3/KECCAK</li>
<li>SHAKE-128/SHAKE-256</li>
<li>BLAKE2s/BLAKE2s</li>
<li>SHA1</li>
</ol>
<p>Hashes which are not yet supported</p>
<ol class="simple"><li>SKEIN</li>
<li>MURMUR</li>
</ol>
</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="varint.html">varint</a>, <a class="reference external" href="vbuffer.html">vbuffer</a>, <a class="reference external" href="multicodec.html">multicodec</a>, <a class="reference external" href="multibase.html">multibase</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="MHash" class="tohide">
<dt><pre><a href="multihash.html#MHash"><span class="Identifier">MHash</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">mcodec</span><span class="Operator">*</span><span class="Other">:</span> <a href="multicodec.html#MultiCodec"><span class="Identifier">MultiCodec</span></a>
<span class="Identifier">size</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">coder</span><span class="Operator">*</span><span class="Other">:</span> <a href="multihash.html#MHashCoderProc"><span class="Identifier">MHashCoderProc</span></a>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L46"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L46" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MHashCoderProc" class="tohide">
<dt><pre><a href="multihash.html#MHashCoderProc"><span class="Identifier">MHashCoderProc</span></a> <span class="Other">=</span> <span class="Keyword">proc</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">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">output</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span> {.
<span class="Identifier">nimcall</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">gcsafe</span><span class="Other">,</span> </span><span class="Identifier">noSideEffect</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L44"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MhResult" class="tohide">
<dt><pre><a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">cstring</span><span class="Other">]</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L57"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="MultiHash" class="tohide">
<dt><pre><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a>
<span class="Identifier">mcodec</span><span class="Operator">*</span><span class="Other">:</span> <a href="multicodec.html#MultiCodec"><span class="Identifier">MultiCodec</span></a>
<span class="Identifier">size</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
<span class="Identifier">dpos</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L51"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="10">
<h1><a class="toc-backref" href="#10">Consts</a></h1>
<dl class="item">
<div id="MaxHashSize" class="tohide">
<dt><pre><a href="multihash.html#MaxHashSize"><span class="Identifier">MaxHashSize</span></a> <span class="Other">=</span> <span class="DecNumber">128</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L36"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L36" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="$,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CMultiHash"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">mh</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>.}</pre></dt>
<dd>
Return string representation of MultiHash <tt class="docutils literal"><span class="pre">value</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L579"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L579" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="==,MultiHash,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CMultiHash%2CMultiHash"><span class="Identifier">`==`</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">;</span> <span class="Identifier">b</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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>.}</pre></dt>
<dd>
Compares MultiHashes <tt class="docutils literal"><span class="pre">a</span></tt> and <tt class="docutils literal"><span class="pre">b</span></tt>, returns <tt class="docutils literal"><span class="pre">true</span></tt> if hashes are equal, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L559"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L559" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="==,MDigest[T],MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CMDigest%5BT%5D%2CMultiHash"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">mdigest</span><span class="Other">:</span> <span class="Identifier">MDigest</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">mh</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Compares MultiHash with nimcrypto's MDigest[T], returns <tt class="docutils literal"><span class="pre">true</span></tt> if hashes are equal, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L554"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L554" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="==,MultiHash,MDigest[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#%3D%3D%2CMultiHash%2CMDigest%5BT%5D"><span class="Identifier">`==`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">mh</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">;</span> <span class="Identifier">mdigest</span><span class="Other">:</span> <span class="Identifier">MDigest</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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>.}</pre></dt>
<dd>
Compares MultiHash with nimcrypto's MDigest[T], returns <tt class="docutils literal"><span class="pre">true</span></tt> if hashes are equal, <tt class="docutils literal"><span class="pre">false</span></tt> otherwise.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L544"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L544" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="base58,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#base58%2CMultiHash"><span class="Identifier">base58</span></a><span class="Other">(</span><span class="Identifier">value</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>.}</pre></dt>
<dd>
Return Base58 encoded string representation of MultiHash <tt class="docutils literal"><span class="pre">value</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L575"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L575" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[MultiHash],openArray[byte],MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D%2CMultiHash"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><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">byte</span><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">mhash</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><span class="Identifier">int</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>.}</pre></dt>
<dd>
<p>Decode MultiHash value from array of bytes <tt class="docutils literal"><span class="pre">data</span></tt>.</p>
<p>On success decoded MultiHash will be stored into <tt class="docutils literal"><span class="pre">mhash</span></tt> and number of bytes consumed will be returned.</p>
<p>On error <tt class="docutils literal"><span class="pre">-1</span></tt> will be returned.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L436"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L436" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="digest,typedesc[MultiHash],int,openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2Ctypedesc%5BMultiHash%5D%2Cint%2CopenArray%5Bbyte%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashcode</span><span class="Other">:</span> <span class="Identifier">int</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">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span>
<a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Perform digest calculation using hash algorithm with code <tt class="docutils literal"><span class="pre">hashcode</span></tt> on data array <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L370"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L370" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="digest,typedesc[MultiHash],string,openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#digest%2Ctypedesc%5BMultiHash%5D%2Cstring%2CopenArray%5Bbyte%5D"><span class="Identifier">digest</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashname</span><span class="Other">:</span> <span class="Identifier">string</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">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span>
<a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Perform digest calculation using hash algorithm with name <tt class="docutils literal"><span class="pre">hashname</span></tt> on data array <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L356"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L356" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,typedesc[MultiBase],string,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CMultiHash"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">mbtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multibase.html#MultiBase"><span class="Identifier">MultiBase</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">encoding</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">mh</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.
<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Get MultiBase encoded representation of <tt class="docutils literal"><span class="pre">mh</span></tt> using encoding <tt class="docutils literal"><span class="pre">encoding</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L589"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L589" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="hex,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#hex%2CMultiHash"><span class="Identifier">hex</span></a><span class="Other">(</span><span class="Identifier">value</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</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>.}</pre></dt>
<dd>
Return hexadecimal string representation of MultiHash <tt class="docutils literal"><span class="pre">value</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L571"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L571" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><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">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span>
<a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from bytes array <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L511"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L511" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.
<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from hexadecimal string representation <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L518"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L518" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],MultiCodec,openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2CMultiCodec%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashcode</span><span class="Other">:</span> <a href="multicodec.html#MultiCodec"><span class="Identifier">MultiCodec</span></a><span class="Other">;</span>
<span class="Identifier">bdigest</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from array of bytes <tt class="docutils literal"><span class="pre">bdigest</span></tt> and hash algorithm code <tt class="docutils literal"><span class="pre">hashcode</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L424"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L424" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],string,openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring%2CopenArray%5Bbyte%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span>
<span class="Identifier">bdigest</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from array of bytes <tt class="docutils literal"><span class="pre">bdigest</span></tt> and hash algorithm code <tt class="docutils literal"><span class="pre">hashcode</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L408"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L408" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init58,typedesc[MultiHash],string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init58%2Ctypedesc%5BMultiHash%5D%2Cstring"><span class="Identifier">init58</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from BASE58 encoded string representation <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L527"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L527" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],MultiCodec,MDigest[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2CMultiCodec%2CMDigest%5BT%5D"><span class="Identifier">init</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashcode</span><span class="Other">:</span> <a href="multicodec.html#MultiCodec"><span class="Identifier">MultiCodec</span></a><span class="Other">;</span>
<span class="Identifier">mdigest</span><span class="Other">:</span> <span class="Identifier">MDigest</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from nimcrypto's <tt class="docutils literal"><span class="pre"><span class="Identifier">MDigest</span></span></tt> and hash algorithm code <tt class="docutils literal"><span class="pre">hashcode</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L396"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L396" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[MultiHash],string,MDigest[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BMultiHash%5D%2Cstring%2CMDigest%5BT%5D"><span class="Identifier">init</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">hashname</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">mdigest</span><span class="Other">:</span> <span class="Identifier">MDigest</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="multihash.html#MhResult"><span class="Identifier">MhResult</span></a><span class="Other">[</span>
<a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">]</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Create MultiHash from nimcrypto's <tt class="docutils literal"><span class="pre"><span class="Identifier">MDigest</span></span></tt> object and hash algorithm name <tt class="docutils literal"><span class="pre">hashname</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L380"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L380" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="validate,typedesc[MultiHash],openArray[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#validate%2Ctypedesc%5BMultiHash%5D%2CopenArray%5Bbyte%5D"><span class="Identifier">validate</span></a><span class="Other">(</span><span class="Identifier">mhtype</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><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">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</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>.}</pre></dt>
<dd>
Returns <tt class="docutils literal"><span class="pre">true</span></tt> if array of bytes <tt class="docutils literal"><span class="pre">data</span></tt> has correct MultiHash inside.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L481"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L481" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="write,VBuffer,MultiHash" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#write%2CVBuffer%2CMultiHash"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a><span class="Other">;</span> <span class="Identifier">mh</span><span class="Other">:</span> <a href="multihash.html#MultiHash"><span class="Identifier">MultiHash</span></a><span class="Other">)</span> {.<span class="Identifier">inline</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>.}</pre></dt>
<dd>
Write MultiHash value <tt class="docutils literal"><span class="pre">mh</span></tt> to buffer <tt class="docutils literal"><span class="pre">vb</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/remove-secio/libp2p/multihash.nim#L585"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multihash.nim#L585" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim. Generated: 2024-03-19 10:48:45 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink