2023-12-11 17:34:25 +00:00
<?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/multibase< / 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/multibase< / 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 >
< 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 >
< 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 = "#7" id = "57" > Types< / a >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#MultiBase"
title="MultiBase = object">MultiBase< / a > < / li >
< li > < a class = "reference" href = "#MultiBaseStatus"
title="MultiBaseStatus {.pure.} = enum
Error, Success, Overrun, Incorrect, BadCodec, NotSupported">MultiBaseStatus< / 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" > decode
< li > < a class = "reference" href = "#decode%2Ctypedesc%5BMultiBase%5D%2CopenArray%5Bchar%5D"
title="decode(mbtype: typedesc[MultiBase]; inbytes: openArray[char]): Result[seq[byte],
string]">decode(mbtype: typedesc[MultiBase]; inbytes: openArray[char]): Result[seq[byte],
string]< / a > < / li >
< li > < a class = "reference" href = "#decode%2Ctypedesc%5BMultiBase%5D%2CopenArray%5Bchar%5D%2CopenArray%5Bbyte%5D%2Cint"
title="decode(mbtype: typedesc[MultiBase]; inbytes: openArray[char];
outbytes: var openArray[byte]; outlen: var int): MultiBaseStatus">decode(mbtype: typedesc[MultiBase]; inbytes: openArray[char];
outbytes: var openArray[byte]; outlen: var int): MultiBaseStatus< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > decodedLength
< li > < a class = "reference" href = "#decodedLength%2Ctypedesc%5BMultiBase%5D%2Cchar%2Cint"
title="decodedLength(mbtype: typedesc[MultiBase]; encoding: char; length: int): int">decodedLength(mbtype: typedesc[MultiBase]; encoding: char; length: int): int< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > encode
< li > < a class = "reference" href = "#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CopenArray%5Bbyte%5D"
title="encode(mbtype: typedesc[MultiBase]; encoding: string; inbytes: openArray[byte]): Result[
string, string]">encode(mbtype: typedesc[MultiBase]; encoding: string; inbytes: openArray[byte]): Result[
string, string]< / a > < / li >
< li > < a class = "reference" href = "#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CopenArray%5Bbyte%5D%2CopenArray%5Bchar%5D%2Cint"
title="encode(mbtype: typedesc[MultiBase]; encoding: string; inbytes: openArray[byte];
outbytes: var openArray[char]; outlen: var int): MultiBaseStatus">encode(mbtype: typedesc[MultiBase]; encoding: string; inbytes: openArray[byte];
outbytes: var openArray[char]; outlen: var int): MultiBaseStatus< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > encodedLength
< li > < a class = "reference" href = "#encodedLength%2Ctypedesc%5BMultiBase%5D%2Cstring%2Cint"
title="encodedLength(mbtype: typedesc[MultiBase]; encoding: string; length: int): int">encodedLength(mbtype: typedesc[MultiBase]; encoding: string; length: int): int< / a > < / li >
< / ul >
< / ul >
< / li >
< / ul >
< / div >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L1"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > < p > This module implements MultiBase.< / p >
< p > TODO:< / p >
< ol class = "simple" > < li > base32z< / li >
< / ol >
< / p >
< div class = "section" id = "7" >
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "MultiBase" class = "tohide" >
< dt > < pre > < a href = "multibase.html#MultiBase" > < span class = "Identifier" > MultiBase< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L25"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L25" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "MultiBaseStatus" class = "tohide" >
< dt > < pre > < a href = "multibase.html#MultiBaseStatus" > < span class = "Identifier" > MultiBaseStatus< / span > < / a > {.< span class = "Identifier" > pure< / span > .} < span class = "Other" > =< / span > < span class = "Keyword" > enum< / span >
< span class = "Identifier" > Error< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > Success< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > Overrun< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > Incorrect< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > BadCodec< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > NotSupported< / span > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L22"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L22" 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 = "decode,typedesc[MultiBase],openArray[char]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#decode%2Ctypedesc%5BMultiBase%5D%2CopenArray%5Bchar%5D" > < span class = "Identifier" > decode< / 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" > inbytes< / 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" > Result< / span > < span class = "Other" > [< / span >
< span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < span class = "Identifier" > byte< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > string< / 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 >
Decode MultiBase encoded array < tt class = "docutils literal" > < span class = "pre" > inbytes< / span > < / tt > and return decoded sequence of bytes.
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L465"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L465" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "decode,typedesc[MultiBase],openArray[char],openArray[byte],int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#decode%2Ctypedesc%5BMultiBase%5D%2CopenArray%5Bchar%5D%2CopenArray%5Bbyte%5D%2Cint" > < span class = "Identifier" > decode< / 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" > inbytes< / 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" > outbytes< / 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" > outlen< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < span class = "Identifier" > int< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multibase.html#MultiBaseStatus" > < span class = "Identifier" > MultiBaseStatus< / 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 > .}< / pre > < / dt >
< dd >
< p > Decode array < tt class = "docutils literal" > < span class = "pre" > inbytes< / span > < / tt > using MultiBase encoding and store decoded value to < tt class = "docutils literal" > < span class = "pre" > outbytes< / span > < / tt > .< / p >
< p > If < tt class = "docutils literal" > < span class = "pre" > inbytes< / span > < / tt > is not correct MultiBase string, then < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.BadCodec< / span > < / tt > if first character is wrong, or < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.Incorrect< / span > < / tt > if string has incorrect characters for such encoding.< / p >
< p > If length of < tt class = "docutils literal" > < span class = "pre" > outbytes< / span > < / tt > is not enough to store decoded result, then < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.Overrun< / span > < / tt > error will be returned and < tt class = "docutils literal" > < span class = "pre" > outlen< / span > < / tt > will be set to length required.< / p >
< p > On successfull decoding < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.Success< / span > < / tt > will be returned and < tt class = "docutils literal" > < span class = "pre" > outlen< / span > < / tt > will be set to number of encoded octets (bytes).< / p >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L411"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L411" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "decodedLength,typedesc[MultiBase],char,int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#decodedLength%2Ctypedesc%5BMultiBase%5D%2Cchar%2Cint" > < span class = "Identifier" > decodedLength< / 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" > char< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > length< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / 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 > .}< / pre > < / dt >
< dd >
Return estimated size of buffer to store MultiBase decoded value with encoding character < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > of length < tt class = "docutils literal" > < span class = "pre" > length< / span > < / tt > .
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L358"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L358" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "encode,typedesc[MultiBase],string,openArray[byte]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CopenArray%5Bbyte%5D" > < 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" > inbytes< / 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" > Result< / span > < span class = "Other" > [< / span > < span class = "Identifier" > string< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > string< / 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 >
Encode array < tt class = "docutils literal" > < span class = "pre" > inbytes< / span > < / tt > using MultiBase encoding scheme < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > and return encoded string.
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L441"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L441" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "encode,typedesc[MultiBase],string,openArray[byte],openArray[char],int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#encode%2Ctypedesc%5BMultiBase%5D%2Cstring%2CopenArray%5Bbyte%5D%2CopenArray%5Bchar%5D%2Cint" > < 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" > inbytes< / 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" > outbytes< / 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 = "Identifier" > outlen< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < span class = "Identifier" > int< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multibase.html#MultiBaseStatus" > < span class = "Identifier" > MultiBaseStatus< / 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 > .}< / pre > < / dt >
< dd >
< p > Encode array < tt class = "docutils literal" > < span class = "pre" > inbytes< / span > < / tt > using MultiBase encoding scheme < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > and store encoded value to < tt class = "docutils literal" > < span class = "pre" > outbytes< / span > < / tt > .< / p >
< p > If < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > is not supported < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.NotSupported< / span > < / tt > will be returned.< / p >
< p > If < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > is not correct string, then < tt class = "docutils literal" > < span class = "pre" > MultBaseStatus.BadCodec< / span > < / tt > will be returned.< / p >
< p > If length of < tt class = "docutils literal" > < span class = "pre" > outbytes< / span > < / tt > is not enough to store encoded result, then < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.Overrun< / span > < / tt > error will be returned and < tt class = "docutils literal" > < span class = "pre" > outlen< / span > < / tt > will be set to length required.< / p >
< p > On successfull encoding < tt class = "docutils literal" > < span class = "pre" > MultiBaseStatus.Success< / span > < / tt > will be returned and < tt class = "docutils literal" > < span class = "pre" > outlen< / span > < / tt > will be set to number of encoded octets (bytes).< / p >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L371"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L371" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "encodedLength,typedesc[MultiBase],string,int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#encodedLength%2Ctypedesc%5BMultiBase%5D%2Cstring%2Cint" > < span class = "Identifier" > encodedLength< / 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" > length< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / 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 > .}< / pre > < / dt >
< dd >
< p > Return estimated size of buffer to store MultiBase encoded value with encoding < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > of length < tt class = "docutils literal" > < span class = "pre" > length< / span > < / tt > .< / p >
< p > Procedure returns < tt class = "docutils literal" > < span class = "pre" > -1< / span > < / tt > if < tt class = "docutils literal" > < span class = "pre" > encoding< / span > < / tt > scheme is not supported or not present.< / p >
< a
href="https://github.com/status-im/nim-libp2p/tree/simplifly-ci-matrix/libp2p/multibase.nim#L342"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multibase.nim#L342" 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 / >
2023-12-12 17:54:35 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2023-12-12 17:54:27 UTC< / small >
2023-12-11 17:34:25 +00:00
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
