2023-10-23 14:50:57 +00:00
<?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" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > libp2p/multicodec< / title >
<!-- 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" >
<!-- JS -->
< script type = "text/javascript" src = "../dochack.js" > < / script >
< / head >
< body >
< div class = "document" id = "documentId" >
< div class = "container" >
< h1 class = "title" > libp2p/multicodec< / h1 >
< div class = "row" >
< div class = "three columns" >
< div class = "theme-select-wrapper" >
< label for = "theme-select" > Theme: < / 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" >
< li > < a id = "indexLink" href = "../theindex.html" > Index< / a > < / li >
< / ul >
< / div >
< div id = "searchInputDiv" >
Search: < input type = "search" 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 = "#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 = "#MultiCodec" title = "MultiCodec = distinct int" > MultiCodec< / a > < / li >
< li > < a class = "reference" href = "#MultiCodecError" title = "MultiCodecError = enum
MultiCodecNotSupported">MultiCodecError< / a > < / li >
< / ul >
< / details >
< / li >
< li >
< details open >
< summary > < a class = "reference reference-toplevel" href = "#10" id = "60" > Consts< / a > < / summary >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#InvalidMultiCodec" title = "InvalidMultiCodec = -1" > InvalidMultiCodec< / 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" > !=
< li > < a class = "reference" href = "#%21%3D%2CMultiCodec%2CMultiCodec" title = "`!=`(a, b: MultiCodec): bool" > `!=`(a, b: MultiCodec): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > $
< li > < a class = "reference" href = "#%24%2CMultiCodec" title = "`$`(mc: MultiCodec): string" > `$`(mc: MultiCodec): string< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > ==
< li > < a class = "reference" href = "#%3D%3D%2CMultiCodec%2CMultiCodec" title = "`==`(a, b: MultiCodec): bool" > `==`(a, b: MultiCodec): bool< / a > < / li >
< li > < a class = "reference" href = "#%3D%3D%2CMultiCodec%2Cint" title = "`==`(mc: MultiCodec; code: int): bool" > `==`(mc: MultiCodec; code: int): bool< / a > < / li >
< li > < a class = "reference" href = "#%3D%3D%2CMultiCodec%2Cstring" title = "`==`(mc: MultiCodec; name: string): bool" > `==`(mc: MultiCodec; name: string): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > codec
< li > < a class = "reference" href = "#codec%2Ctypedesc%5BMultiCodec%5D%2Cint" title = "codec(mt: typedesc[MultiCodec]; code: int): MultiCodec" > codec(mt: typedesc[MultiCodec]; code: int): MultiCodec< / a > < / li >
< li > < a class = "reference" href = "#codec%2Ctypedesc%5BMultiCodec%5D%2Cstring" title = "codec(mt: typedesc[MultiCodec]; name: string): MultiCodec" > codec(mt: typedesc[MultiCodec]; name: string): MultiCodec< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > hash
< li > < a class = "reference" href = "#hash%2CMultiCodec" title = "hash(m: MultiCodec): Hash" > hash(m: MultiCodec): Hash< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > multiCodec
< li > < a class = "reference" href = "#multiCodec%2Cint" title = "multiCodec(code: int): MultiCodec" > multiCodec(code: int): MultiCodec< / a > < / li >
< li > < a class = "reference" href = "#multiCodec%2Cstring" title = "multiCodec(name: string): MultiCodec" > multiCodec(name: string): MultiCodec< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > write
< li > < a class = "reference" href = "#write%2CVBuffer%2CMultiCodec" title = "write(vb: var VBuffer; mc: MultiCodec)" > write(vb: var VBuffer; mc: MultiCodec)< / a > < / li >
< / ul >
< / ul >
< / details >
< / li >
< / ul >
< / div >
< div class = "nine columns" id = "content" >
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L1" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > This module implements MultiCodec.List of officially supported codecs can BE found here < a class = "reference external" href = "https://github.com/multiformats/multicodec/blob/master/table.csv" > https://github.com/multiformats/multicodec/blob/master/table.csv< / a > < / 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 >
< / dl >
< / div >
< div class = "section" id = "7" >
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "MultiCodec" class = "tohide" >
< dt > < pre > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > distinct< / span > < span class = "Identifier" > int< / span > < / pre > < / dt >
< dd >
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L239" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L239" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "MultiCodecError" class = "tohide" >
< dt > < pre > < a href = "multicodec.html#MultiCodecError" > < span class = "Identifier" > MultiCodecError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > enum< / span >
< span class = "Identifier" > MultiCodecNotSupported< / span > < / pre > < / dt >
< dd >
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L240" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L240" 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 = "InvalidMultiCodec" class = "tohide" >
< dt > < pre > < a href = "multicodec.html#InvalidMultiCodec" > < span class = "Identifier" > InvalidMultiCodec< / span > < / a > < span class = "Other" > =< / span > < span class = "DecNumber" > -1< / span > < / pre > < / dt >
< dd >
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L244" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L244" 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 = "!=-procs-all" >
< div id = "!=,MultiCodec,MultiCodec" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#%21%3D%2CMultiCodec%2CMultiCodec" > < span class = "Identifier" > `!=`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > a< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > b< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 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 < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if MultiCodecs < tt class = "docutils literal" > < span class = "pre" > a< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > b< / span > < / tt > are not equal.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L291" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L291" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "$-procs-all" >
< div id = "$,MultiCodec" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#%24%2CMultiCodec" > < span class = "Identifier" > `$`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > mc< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 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 string representation of MultiCodec < tt class = "docutils literal" > < span class = "pre" > mc< / span > < / tt > .
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L270" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L270" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "==-procs-all" >
< div id = "==,MultiCodec,MultiCodec" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#%3D%3D%2CMultiCodec%2CMultiCodec" > < span class = "Identifier" > `==`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > a< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > b< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 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 < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if MultiCodecs < tt class = "docutils literal" > < span class = "pre" > a< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > b< / span > < / tt > are equal.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L287" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L287" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "==,MultiCodec,int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#%3D%3D%2CMultiCodec%2Cint" > < span class = "Identifier" > `==`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > mc< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > code< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < 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 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 >
Compares MultiCodec < tt class = "docutils literal" > < span class = "pre" > mc< / span > < / tt > with integer < tt class = "docutils literal" > < span class = "pre" > code< / span > < / tt > .
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L283" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L283" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "==,MultiCodec,string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#%3D%3D%2CMultiCodec%2Cstring" > < span class = "Identifier" > `==`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > mc< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > name< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < 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 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 >
Compares MultiCodec < tt class = "docutils literal" > < span class = "pre" > mc< / span > < / tt > with string < tt class = "docutils literal" > < span class = "pre" > name< / span > < / tt > .
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L276" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L276" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "codec-procs-all" >
< div id = "codec,typedesc[MultiCodec],int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#codec%2Ctypedesc%5BMultiCodec%5D%2Cint" > < span class = "Identifier" > codec< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > mt< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > code< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 >
Return MultiCodec from integer representation < tt class = "docutils literal" > < span class = "pre" > code< / span > < / tt > . If < tt class = "docutils literal" > < span class = "pre" > code< / span > < / tt > is not valid multicodec code, then < tt class = "docutils literal" > < span class = "pre" > InvalidMultiCodec< / span > < / tt > will be returned.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L305" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L305" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "codec,typedesc[MultiCodec],string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#codec%2Ctypedesc%5BMultiCodec%5D%2Cstring" > < span class = "Identifier" > codec< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > mt< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > name< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 >
Return MultiCodec from string representation < tt class = "docutils literal" > < span class = "pre" > name< / span > < / tt > . If < tt class = "docutils literal" > < span class = "pre" > name< / span > < / tt > is not valid multicodec name, then < tt class = "docutils literal" > < span class = "pre" > InvalidMultiCodec< / span > < / tt > will be returned.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L299" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L299" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "hash-procs-all" >
< div id = "hash,MultiCodec" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#hash%2CMultiCodec" > < span class = "Identifier" > hash< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > m< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Hash< / 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 class = "Other" > ,< / span > < span class = "Identifier" > forbids< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
Hash procedure for tables.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L295" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L295" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "multiCodec-procs-all" >
< div id = "multiCodec,int" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#multiCodec%2Cint" > < span class = "Identifier" > multiCodec< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > code< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > {.< span class = "Identifier" > compileTime< / 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 >
Generate MultiCodec from integer < tt class = "docutils literal" > < span class = "pre" > code< / span > < / tt > at compile time.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L264" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L264" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "multiCodec,string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#multiCodec%2Cstring" > < span class = "Identifier" > multiCodec< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > name< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / span > < / a > {.< span class = "Identifier" > compileTime< / 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 >
Generate MultiCodec from string < tt class = "docutils literal" > < span class = "pre" > name< / span > < / tt > at compile time.
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L258" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L258" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< div id = "write-procs-all" >
< div id = "write,VBuffer,MultiCodec" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#write%2CVBuffer%2CMultiCodec" > < 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" > mc< / span > < span class = "Other" > :< / span > < a href = "multicodec.html#MultiCodec" > < span class = "Identifier" > MultiCodec< / 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 class = "Other" > ,< / span >
< span class = "Identifier" > forbids< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
Write MultiCodec to buffer < tt class = "docutils literal" > < span class = "pre" > vb< / span > < / tt > .
< a href = "https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/multicodec.nim#L315" class = "link-seesrc" target = "_blank" > Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/multicodec.nim#L315" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / div >
< / dl >
< / div >
< / div >
< / div >
< div class = "twelve-columns footer" >
< span class = "nim-sprite" > < / span >
< br >
2023-11-07 12:24:40 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2023-11-07 12:24:36 UTC< / small >
2023-10-23 14:50:57 +00:00
< / div >
< / div >
< / div >
<!-- 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' / >
< / body >
< / html >
