2023-10-23 14:50:57 +00:00
<?xml version="1.0" encoding="utf-8" ?>
2023-12-21 17:01:50 +00:00
< !DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2023-10-23 14:50:57 +00:00
<!-- This file is generated by Nim. -->
2023-12-21 17:01:50 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" lang = "en" >
2023-10-23 14:50:57 +00:00
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" / >
2023-12-21 17:01:50 +00:00
2023-10-23 14:50:57 +00:00
< 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=" >
2023-12-21 17:01:50 +00:00
<!-- 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' / >
2023-10-23 14:50:57 +00:00
<!-- CSS -->
2023-12-21 17:01:50 +00:00
< title > libp2p/peerid< / title >
2023-10-23 14:50:57 +00:00
< link rel = "stylesheet" type = "text/css" href = "../nimdoc.out.css" >
< script type = "text/javascript" src = "../dochack.js" > < / script >
2023-12-21 17:01:50 +00:00
< 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 >
2023-10-23 14:50:57 +00:00
< / head >
< body >
2023-12-21 17:01:50 +00:00
< div class = "document" id = "documentId" >
< div class = "container" >
< h1 class = "title" > libp2p/peerid< / h1 >
< div class = "row" >
2023-10-23 14:50:57 +00:00
< div class = "three columns" >
2023-12-21 17:01:50 +00:00
< 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" >
2023-10-23 14:50:57 +00:00
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 >
2023-12-21 17:01:50 +00:00
< ul class = "simple simple-toc-section" >
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< li >
2023-12-21 17:01:50 +00:00
< a class = "reference reference-toplevel" href = "#7" id = "57" > Types< / a >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#PeerId"
title="PeerId = object
2023-10-23 14:50:57 +00:00
data*: seq[byte]">PeerId< / a > < / li >
2023-12-21 17:01:50 +00:00
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< li >
2023-12-21 17:01:50 +00:00
< a class = "reference reference-toplevel" href = "#10" id = "60" > Consts< / a >
< ul class = "simple simple-toc-section" >
< li > < a class = "reference" href = "#maxInlineKeyLength"
title="maxInlineKeyLength = 42">maxInlineKeyLength< / a > < / li >
2023-10-23 14:50:57 +00:00
2023-12-21 17:01:50 +00:00
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< li >
2023-12-21 17:01:50 +00:00
< a class = "reference reference-toplevel" href = "#12" id = "62" > Procs< / a >
< ul class = "simple simple-toc-section" >
2023-10-23 14:50:57 +00:00
< ul class = "simple nested-toc-section" > $
2023-12-21 17:01:50 +00:00
< li > < a class = "reference" href = "#%24%2CPeerId"
title="`$`(pid: PeerId): string">`$`(pid: PeerId): string< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > cmp
< li > < a class = "reference" href = "#cmp%2CPeerId%2CPeerId"
title="cmp(a, b: PeerId): int">cmp(a, b: PeerId): int< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > extractPublicKey
< li > < a class = "reference" href = "#extractPublicKey%2CPeerId%2CPublicKey"
title="extractPublicKey(pid: PeerId; pubkey: var PublicKey): bool">extractPublicKey(pid: PeerId; pubkey: var PublicKey): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > getField
< li > < a class = "reference" href = "#getField%2CProtoBuffer%2Cint%2CPeerId"
title="getField(pb: ProtoBuffer; field: int; pid: var PeerId): ProtoResult[bool]">getField(pb: ProtoBuffer; field: int; pid: var PeerId): ProtoResult[bool]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > hasPublicKey
< li > < a class = "reference" href = "#hasPublicKey%2CPeerId"
title="hasPublicKey(pid: PeerId): bool">hasPublicKey(pid: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > hex
< li > < a class = "reference" href = "#hex%2CPeerId"
title="hex(pid: PeerId): string">hex(pid: PeerId): string< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > init
< li > < a class = "reference" href = "#init%2CPeerId%2CopenArray%5Bbyte%5D"
title="init(pid: var PeerId; data: openArray[byte]): bool">init(pid: var PeerId; data: openArray[byte]): bool< / a > < / li >
< li > < a class = "reference" href = "#init%2CPeerId%2Cstring"
title="init(pid: var PeerId; data: string): bool">init(pid: var PeerId; data: string): bool< / a > < / li >
< li > < a class = "reference" href = "#init%2Ctypedesc%5BPeerId%5D%2CopenArray%5Bbyte%5D"
title="init(t: typedesc[PeerId]; data: openArray[byte]): Result[PeerId, cstring]">init(t: typedesc[PeerId]; data: openArray[byte]): Result[PeerId, cstring]< / a > < / li >
< li > < a class = "reference" href = "#init%2Ctypedesc%5BPeerId%5D%2Cstring"
title="init(t: typedesc[PeerId]; data: string): Result[PeerId, cstring]">init(t: typedesc[PeerId]; data: string): Result[PeerId, cstring]< / a > < / li >
< li > < a class = "reference" href = "#init%2Ctypedesc%5BPeerId%5D%2CPublicKey"
title="init(t: typedesc[PeerId]; pubkey: PublicKey): Result[PeerId, cstring]">init(t: typedesc[PeerId]; pubkey: PublicKey): Result[PeerId, cstring]< / a > < / li >
< li > < a class = "reference" href = "#init%2Ctypedesc%5BPeerId%5D%2CPrivateKey"
title="init(t: typedesc[PeerId]; seckey: PrivateKey): Result[PeerId, cstring]">init(t: typedesc[PeerId]; seckey: PrivateKey): Result[PeerId, cstring]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > match
< li > < a class = "reference" href = "#match%2CPeerId%2CPublicKey"
title="match(pid: PeerId; pubkey: PublicKey): bool">match(pid: PeerId; pubkey: PublicKey): bool< / a > < / li >
< li > < a class = "reference" href = "#match%2CPeerId%2CPrivateKey"
title="match(pid: PeerId; seckey: PrivateKey): bool">match(pid: PeerId; seckey: PrivateKey): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > random
< li > < a class = "reference" href = "#random%2Ctypedesc%5BPeerId%5D"
title="random(t: typedesc[PeerId]; rng = newRng()): Result[PeerId, cstring]">random(t: typedesc[PeerId]; rng = newRng()): Result[PeerId, cstring]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > shortLog
< li > < a class = "reference" href = "#shortLog%2CPeerId"
title="shortLog(pid: PeerId): string">shortLog(pid: PeerId): string< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > toBytes
< li > < a class = "reference" href = "#toBytes%2CPeerId%2CopenArray%5Bbyte%5D"
title="toBytes(pid: PeerId; data: var openArray[byte]): int">toBytes(pid: PeerId; data: var openArray[byte]): int< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > validate
< li > < a class = "reference" href = "#validate%2CPeerId"
title="validate(pid: PeerId): bool">validate(pid: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > write
< li > < a class = "reference" href = "#write%2CProtoBuffer%2Cint%2CPeerId"
title="write(pb: var ProtoBuffer; field: int; pid: PeerId)">write(pb: var ProtoBuffer; field: int; pid: PeerId)< / a > < / li >
< li > < a class = "reference" href = "#write%2CVBuffer%2CPeerId"
title="write(vb: var VBuffer; pid: PeerId)">write(vb: var VBuffer; pid: PeerId)< / a > < / li >
< / ul >
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< li >
2023-12-21 17:01:50 +00:00
< a class = "reference reference-toplevel" href = "#18" id = "68" > Templates< / a >
< ul class = "simple simple-toc-section" >
2023-10-23 14:50:57 +00:00
< ul class = "simple nested-toc-section" > <
2023-12-21 17:01:50 +00:00
< li > < a class = "reference" href = "#%3C.t%2CPeerId%2CPeerId"
title="`< `(a, b: PeerId): bool">`< `(a, b: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > < =
< li > < a class = "reference" href = "#%3C%3D.t%2CPeerId%2CPeerId"
title="`< =`(a, b: PeerId): bool">`< =`(a, b: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > ==
< li > < a class = "reference" href = "#%3D%3D.t%2CPeerId%2CPeerId"
title="`==`(a, b: PeerId): bool">`==`(a, b: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > >
< li > < a class = "reference" href = "#%3E.t%2CPeerId%2CPeerId"
title="`> `(a, b: PeerId): bool">`> `(a, b: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > >=
< li > < a class = "reference" href = "#%3E%3D.t%2CPeerId%2CPeerId"
title="`> =`(a, b: PeerId): bool">`> =`(a, b: PeerId): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > formatItIMPL
< li > < a class = "reference" href = "#formatItIMPL.t%2CPeerId"
title="formatItIMPL(it: PeerId): auto">formatItIMPL(it: PeerId): auto< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > getBytes
< li > < a class = "reference" href = "#getBytes.t%2CPeerId"
title="getBytes(pid: PeerId): seq[byte]">getBytes(pid: PeerId): seq[byte]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > hash
< li > < a class = "reference" href = "#hash.t%2CPeerId"
title="hash(pid: PeerId): Hash">hash(pid: PeerId): Hash< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > len
< li > < a class = "reference" href = "#len.t%2CPeerId"
title="len(pid: PeerId): int">len(pid: PeerId): int< / a > < / li >
< / ul >
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< li >
< a class = "reference reference-toplevel" href = "#19" id = "69" > Exports< / a >
2023-12-21 17:01:50 +00:00
< ul class = "simple simple-toc-section" >
< / ul >
2023-10-23 14:50:57 +00:00
< / li >
< / ul >
< / div >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L1"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
2023-12-21 17:01:50 +00:00
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > This module implementes API for libp2p peer.Serialization/Deserialization helpers< / p >
< div class = "section" id = "6" >
< h1 > < a class = "toc-backref" href = "#6" > Imports< / a > < / h1 >
< dl class = "item" >
< a class = "reference external" href = "utility.html" > utility< / a > , < a class = "reference external" href = "crypto/crypto.html" > crypto/crypto< / a > , < a class = "reference external" href = "multicodec.html" > multicodec< / a > , < a class = "reference external" href = "multihash.html" > multihash< / a > , < a class = "reference external" href = "vbuffer.html" > vbuffer< / a > , < a class = "reference external" href = "protobuf/minprotobuf.html" > protobuf/minprotobuf< / a >
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< div class = "section" id = "7" >
2023-12-21 17:01:50 +00:00
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span >
< span class = "Identifier" > data< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < span class = "Identifier" > byte< / span > < span class = "Other" > ]< / span >
< / pre > < / dt >
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L30"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L30" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< div class = "section" id = "10" >
2023-12-21 17:01:50 +00:00
< h1 > < a class = "toc-backref" href = "#10" > Consts< / a > < / h1 >
< dl class = "item" >
< div id = "maxInlineKeyLength" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < a href = "peerid.html#maxInlineKeyLength" > < span class = "Identifier" > maxInlineKeyLength< / span > < / a > < span class = "Other" > =< / span > < span class = "DecNumber" > 42< / span > < / pre > < / dt >
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L27"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L27" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< div class = "section" id = "12" >
2023-12-21 17:01:50 +00:00
< h1 > < a class = "toc-backref" href = "#12" > Procs< / a > < / h1 >
< dl class = "item" >
< div id = "$,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#%24%2CPeerId" > < span class = "Identifier" > `$`< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Return base58 encoded < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > representation.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L33"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L33" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "cmp,PeerId,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#cmp%2CPeerId%2CPeerId" > < span class = "Identifier" > cmp< / 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
2023-12-21 17:01:50 +00:00
Compares two peer ids < tt class = "docutils literal" > < span class = "pre" > a< / span > < / tt > and < tt class = "docutils literal" > < span class = "pre" > b< / span > < / tt > . Returns:< p > 0 iff a == b< br / > < 0 iff a < b< br / > > 0 iff a > b< br / > < / p >
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L70"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L70" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "extractPublicKey,PeerId,PublicKey" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#extractPublicKey%2CPeerId%2CPublicKey" > < span class = "Identifier" > extractPublicKey< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > pubkey< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < a href = "crypto/crypto.html#PublicKey" > < span class = "Identifier" > PublicKey< / 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 >
2023-12-21 17:01:50 +00:00
< / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
< p > Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if public key was successfully decoded from PeerId < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > and stored to < tt class = "docutils literal" > < span class = "pre" > pubkey< / span > < / tt > .< / p >
< p > Returns < tt class = "docutils literal" > < span class = "pre" > false< / span > < / tt > otherwise.< / p >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L115"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L115" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "getField,ProtoBuffer,int,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#getField%2CProtoBuffer%2Cint%2CPeerId" > < span class = "Identifier" > getField< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pb< / span > < span class = "Other" > :< / span > < a href = "protobuf/minprotobuf.html#ProtoBuffer" > < span class = "Identifier" > ProtoBuffer< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > field< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "protobuf/minprotobuf.html#ProtoResult" > < span class = "Identifier" > ProtoResult< / span > < / a > < span class = "Other" > [< / span > < span class = "Identifier" > bool< / span > < span class = "Other" > ]< / span > {.
2023-12-21 17:01:50 +00:00
< 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Read < tt class = "docutils literal" > < span class = "pre" > PeerId< / span > < / tt > from ProtoBuf's message and validate it
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L204"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L204" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "hasPublicKey,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#hasPublicKey%2CPeerId" > < span class = "Identifier" > hasPublicKey< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > is small enough to hold public key inside.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L107"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L107" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "hex,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#hex%2CPeerId" > < span class = "Identifier" > hex< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Returns hexadecimal string representation of < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L62"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L62" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "init,PeerId,openArray[byte]" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2CPeerId%2CopenArray%5Bbyte%5D" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > data< / span > < span class = "Other" > :< / span > < span class = "Identifier" > openArray< / span > < span class = "Other" > [< / span > < span class = "Identifier" > 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 class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
2023-12-21 17:01:50 +00:00
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
< p > Initialize peer id from raw binary representation < tt class = "docutils literal" > < span class = "pre" > data< / span > < / tt > .< / p >
< p > Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if peer was successfully initialiazed.< / p >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L127"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L127" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "init,PeerId,string" class = "tohide" >
2023-12-21 17:01:50 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2CPeerId%2Cstring" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < 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 > < 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
< p > Initialize peer id from base58 encoded string representation.< / p >
< p > Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if peer was successfully initialiazed.< / p >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L136"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L136" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "init,typedesc[PeerId],openArray[byte]" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2Ctypedesc%5BPeerId%5D%2CopenArray%5Bbyte%5D" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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" > Result< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < span class = "Identifier" > cstring< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
Create new peer id from raw binary representation < tt class = "docutils literal" > < span class = "pre" > data< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L150"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L150" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "init,typedesc[PeerId],string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2Ctypedesc%5BPeerId%5D%2Cstring" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > Result< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < span class = "Identifier" > cstring< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
Create new peer id from base58 encoded string representation < tt class = "docutils literal" > < span class = "pre" > data< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L158"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L158" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "init,typedesc[PeerId],PublicKey" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2Ctypedesc%5BPeerId%5D%2CPublicKey" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > pubkey< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PublicKey" > < span class = "Identifier" > PublicKey< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Result< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < span class = "Identifier" > cstring< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
Create new peer id from public key < tt class = "docutils literal" > < span class = "pre" > pubkey< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L166"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L166" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "init,typedesc[PeerId],PrivateKey" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#init%2Ctypedesc%5BPeerId%5D%2CPrivateKey" > < span class = "Identifier" > init< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > seckey< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PrivateKey" > < span class = "Identifier" > PrivateKey< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Result< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < span class = "Identifier" > cstring< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
Create new peer id from private key < tt class = "docutils literal" > < span class = "pre" > seckey< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L177"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L177" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "match,PeerId,PublicKey" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#match%2CPeerId%2CPublicKey" > < span class = "Identifier" > match< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > pubkey< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PublicKey" > < span class = "Identifier" > PublicKey< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
2023-12-21 17:01:50 +00:00
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > matches public key < tt class = "docutils literal" > < span class = "pre" > pubkey< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L186"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L186" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "match,PeerId,PrivateKey" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#match%2CPeerId%2CPrivateKey" > < span class = "Identifier" > match< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > seckey< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PrivateKey" > < span class = "Identifier" > PrivateKey< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
2023-12-21 17:01:50 +00:00
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Returns < tt class = "docutils literal" > < span class = "pre" > true< / span > < / tt > if < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > matches private key < tt class = "docutils literal" > < span class = "pre" > seckey< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L190"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L190" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "random,typedesc[PeerId]" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#random%2Ctypedesc%5BPeerId%5D" > < span class = "Identifier" > random< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > t< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > rng< / span > < span class = "Other" > =< / span > < span class = "Identifier" > newRng< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Result< / span > < span class = "Other" > [< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < span class = "Identifier" > cstring< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
Create new peer id with random public key.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L181"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L181" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "shortLog,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#shortLog%2CPeerId" > < span class = "Identifier" > shortLog< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Returns compact string representation of < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L38"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L38" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "toBytes,PeerId,openArray[byte]" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#toBytes%2CPeerId%2CopenArray%5Bbyte%5D" > < span class = "Identifier" > toBytes< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > data< / 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 = "Other" > :< / span > < span class = "Identifier" > int< / span > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
2023-12-21 17:01:50 +00:00
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
< p > Store PeerId < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > to array of bytes < tt class = "docutils literal" > < span class = "pre" > data< / span > < / tt > .< / p >
< p > Returns number of bytes needed to store < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > .< / p >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L50"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L50" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "validate,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#validate%2CPeerId" > < span class = "Identifier" > validate< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Validate check if < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > is empty or not.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L103"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L103" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "write,ProtoBuffer,int,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#write%2CProtoBuffer%2Cint%2CPeerId" > < span class = "Identifier" > write< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pb< / span > < span class = "Other" > :< / span > < span class = "Keyword" > var< / span > < a href = "protobuf/minprotobuf.html#ProtoBuffer" > < span class = "Identifier" > ProtoBuffer< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > field< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
2023-12-21 17:01:50 +00:00
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Write PeerId value < tt class = "docutils literal" > < span class = "pre" > peerid< / span > < / tt > to object < tt class = "docutils literal" > < span class = "pre" > pb< / span > < / tt > using ProtoBuf's encoding.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L200"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L200" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
< div id = "write,VBuffer,PeerId" class = "tohide" >
2023-12-21 17:01:50 +00:00
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#write%2CVBuffer%2CPeerId" > < 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" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
Write PeerId value < tt class = "docutils literal" > < span class = "pre" > peerid< / span > < / tt > to buffer < tt class = "docutils literal" > < span class = "pre" > vb< / span > < / tt > .
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L196"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L196" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< div class = "section" id = "18" >
2023-12-21 17:01:50 +00:00
< h1 > < a class = "toc-backref" href = "#18" > Templates< / a > < / h1 >
< dl class = "item" >
< div id = "<=.t,PeerId,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#%3C%3D.t%2CPeerId%2CPeerId" > < 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > < / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L85"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L85" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "<.t,PeerId,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#%3C.t%2CPeerId%2CPeerId" > < 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > < / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L88"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L88" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "==.t,PeerId,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#%3D%3D.t%2CPeerId%2CPeerId" > < 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > < / pre > < / dt >
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L97"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L97" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = ">=.t,PeerId,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#%3E%3D.t%2CPeerId%2CPeerId" > < 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > < / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L91"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L91" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = ">.t,PeerId,PeerId" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#%3E.t%2CPeerId%2CPeerId" > < 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 = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > < / pre > < / dt >
2023-10-23 14:50:57 +00:00
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L94"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L94" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "formatItIMPL.t,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#formatItIMPL.t%2CPeerId" > < span class = "Identifier" > formatItIMPL< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > it< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > auto< / span > < / pre > < / dt >
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L48"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L48" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "getBytes.t,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#getBytes.t%2CPeerId" > < span class = "Identifier" > getBytes< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < span class = "Identifier" > byte< / span > < span class = "Other" > ]< / span > < / pre > < / dt >
< dd >
Return PeerId < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > as array of bytes.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L58"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L58" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "hash.t,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#hash.t%2CPeerId" > < span class = "Identifier" > hash< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Hash< / span > < / pre > < / dt >
< dd >
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L100"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L100" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< div id = "len.t,PeerId" class = "tohide" >
2023-10-23 14:50:57 +00:00
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#len.t%2CPeerId" > < span class = "Identifier" > len< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > pid< / span > < span class = "Other" > :< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < / pre > < / dt >
< dd >
Returns length of < tt class = "docutils literal" > < span class = "pre" > pid< / span > < / tt > binary representation.
2023-12-21 17:01:50 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/zz-dbg/libp2p/peerid.nim#L66"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerid.nim#L66" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-10-23 14:50:57 +00:00
< / dd >
< / div >
2023-12-21 17:01:50 +00:00
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< div class = "section" id = "19" >
2023-12-21 17:01:50 +00:00
< h1 > < a class = "toc-backref" href = "#19" > Exports< / a > < / h1 >
< dl class = "item" >
< a href = "utility.html#withValue.t,,untyped,untyped" > < span class = "Identifier" > withValue< / span > < / a > , < a href = "utility.html#safeConvert.t,S" > < span class = "Identifier" > safeConvert< / span > < / a > , < a href = "utility.html#shortLog,openArray[byte]" > < span class = "Identifier" > shortLog< / span > < / a > , < a href = "utility.html#withValue.m,,untyped,untyped,untyped" > < span class = "Identifier" > withValue< / span > < / a > , < a href = "utility.html#public.t" > < span class = "Identifier" > public< / span > < / a > , < a href = "utility.html#exceptionToAssert.t,untyped" > < span class = "Identifier" > exceptionToAssert< / span > < / a > , < a href = "utility.html#valueOr.t,Option[T],untyped" > < span class = "Identifier" > valueOr< / span > < / a > , < a href = "utility.html#shortLog,string" > < span class = "Identifier" > shortLog< / span > < / a > , < a href = "utility.html#compilesOr.t,untyped,untyped" > < span class = "Identifier" > compilesOr< / span > < / a > , < a href = "utility.html#capLen,seq[T],Natural" > < span class = "Identifier" > capLen< / span > < / a > , < a href = "utility.html#toOpt.t,Result[T,E]" > < span class = "Identifier" > toOpt< / span > < / a >
< / dl > < / div >
2023-10-23 14:50:57 +00:00
< / div >
< / div >
2023-12-21 17:01:50 +00:00
< div class = "row" >
2023-10-23 14:50:57 +00:00
< div class = "twelve-columns footer" >
< span class = "nim-sprite" > < / span >
2023-12-21 17:01:50 +00:00
< br / >
2024-01-25 15:42:41 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2024-01-25 15:42:34 UTC< / small >
2023-10-23 14:50:57 +00:00
< / div >
< / div >
< / div >
2023-12-21 17:01:50 +00:00
< / div >
2023-10-23 14:50:57 +00:00
< / body >
< / html >