<?xml version="1.0" encoding="utf-8" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <!-- This file is generated by Nim. --> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- Favicon --> <link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/> <link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII="> <!-- Google fonts --> <link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/> <link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/> <!-- CSS --> <title>libp2p/utility</title> <link rel="stylesheet" type="text/css" href="../nimdoc.out.css"> <script type="text/javascript" src="../dochack.js"></script> <script type="text/javascript"> function main() { var pragmaDots = document.getElementsByClassName("pragmadots"); for (var i = 0; i < pragmaDots.length; i++) { pragmaDots[i].onclick = function(event) { // Hide tease event.target.parentNode.style.display = "none"; // Show actual event.target.parentNode.nextElementSibling.style.display = "inline"; } } function switchTheme(e) { if (e.target.checked) { document.documentElement.setAttribute('data-theme', 'dark'); localStorage.setItem('theme', 'dark'); } else { document.documentElement.setAttribute('data-theme', 'light'); localStorage.setItem('theme', 'light'); } } const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]'); if (toggleSwitch !== null) { toggleSwitch.addEventListener('change', switchTheme, false); } var currentTheme = localStorage.getItem('theme'); if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) { currentTheme = 'dark'; } if (currentTheme) { document.documentElement.setAttribute('data-theme', currentTheme); if (currentTheme === 'dark' && toggleSwitch !== null) { toggleSwitch.checked = true; } } } window.addEventListener('DOMContentLoaded', main); </script> </head> <body> <div class="document" id="documentId"> <div class="container"> <h1 class="title">libp2p/utility</h1> <div class="row"> <div class="three columns"> <div class="theme-switch-wrapper"> <label class="theme-switch" for="checkbox"> <input type="checkbox" id="checkbox" /> <div class="slider round"></div> </label> <em>Dark Mode</em> </div> <div id="global-links"> <ul class="simple"> <li> <a href="../theindex.html">Index</a> </li> </ul> </div> <div id="searchInputDiv"> Search: <input type="text" id="searchInput" onkeyup="search()" /> </div> <div> Group by: <select onchange="groupBy(this.value)"> <option value="section">Section</option> <option value="type">Type</option> </select> </div> <script type="text/javascript"> function main2() { // Create the slider var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0]; var newSlider = document.createRange().createContextualFragment(` <div class="theme-switch-wrapper"> <label class="theme-switch" for="internalcheckbox"> <input type="checkbox" id="internalcheckbox"> <div class="slider round"></div> </label> <em>Internal</em> </div> `); var sliderInst = firstSlider.after(newSlider); // Restore slider state from storage var currentMode = localStorage.getItem('privateMode'); if (currentMode == "private") { document.getElementById("internalcheckbox").checked = true; } else { hidePrivateProcs(); } document.getElementById("internalcheckbox").onclick = togglePrivateProcs; } function hidePrivateProcs() { var toHide = document.getElementsByClassName("tohide"); for (var i = 0; i < toHide.length; i++) { var pragmas = toHide[i].querySelectorAll("span.Identifier"); var public = false; for (var z = 0; z < pragmas.length; z++) { if (pragmas[z].innerText == "public") { public = true; break; } } if (public == false) { toHide[i].style.display = "none"; toHide[i].classList.add("hidden"); links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']"); for (var y = 0; y < links.length; y++) { links[y].parentNode.style.display = "none"; links[y].parentNode.classList.add("hidden"); } } } // TOC var nestedSections = document.getElementsByClassName("nested-toc-section"); for (var i = 0; i < nestedSections.length; i++) { if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) { nestedSections[i].style.display = "none"; nestedSections[i].classList.add("hidden"); } } var sections = document.getElementsByClassName("simple-toc-section"); for (var i = 0; i < sections.length; i++) { if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) { sections[i].parentNode.style.display = "none"; sections[i].parentNode.classList.add("hidden"); } } // Sections var sections = document.getElementsByClassName("section"); for (var i = 0; i < sections.length; i++) { if (sections[i].querySelectorAll(".item > div").length == 0) continue; if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) { sections[i].style.display = "none"; sections[i].classList.add("hidden"); } } } function showPrivateProcs() { var toHide = Array.from(document.getElementsByClassName("hidden")); for (var i = 0; i < toHide.length; i++) { toHide[i].style.display = ""; toHide[i].classList.remove("hidden"); } } function togglePrivateProcs() { if (document.getElementById("internalcheckbox").checked) { localStorage.setItem('privateMode', 'private'); showPrivateProcs(); } else { localStorage.setItem('privateMode', 'public'); hidePrivateProcs(); } } window.addEventListener("DOMContentLoaded", main2); </script> <ul class="simple simple-toc" id="toc-list"> <li> <a class="reference reference-toplevel" href="#12" id="62">Procs</a> <ul class="simple simple-toc-section"> <ul class="simple nested-toc-section">capLen <li><a class="reference" href="#capLen%2Cseq%5BT%5D%2CNatural" title="capLen[T](s: var seq[T]; length: Natural)">capLen[T](s: var seq[T]; length: Natural)</a></li> </ul> <ul class="simple nested-toc-section">shortLog <li><a class="reference" href="#shortLog%2CopenArray%5Bbyte%5D" title="shortLog(item: openArray[byte]): string">shortLog(item: openArray[byte]): string</a></li> <li><a class="reference" href="#shortLog%2Cstring" title="shortLog(item: string): string">shortLog(item: string): string</a></li> </ul> </ul> </li> <li> <a class="reference reference-toplevel" href="#17" id="67">Macros</a> <ul class="simple simple-toc-section"> <ul class="simple nested-toc-section">withValue <li><a class="reference" href="#withValue.m%2C%2Cuntyped%2Cuntyped%2Cuntyped" title="withValue[T](self: Opt[T] | Option[T]; value, body, elseStmt: untyped): untyped">withValue[T](self: Opt[T] | Option[T]; value, body, elseStmt: untyped): untyped</a></li> </ul> </ul> </li> <li> <a class="reference reference-toplevel" href="#18" id="68">Templates</a> <ul class="simple simple-toc-section"> <ul class="simple nested-toc-section">compilesOr <li><a class="reference" href="#compilesOr.t%2Cuntyped%2Cuntyped" title="compilesOr(a, b: untyped): untyped">compilesOr(a, b: untyped): untyped</a></li> </ul> <ul class="simple nested-toc-section">exceptionToAssert <li><a class="reference" href="#exceptionToAssert.t%2Cuntyped" title="exceptionToAssert(body: untyped): untyped">exceptionToAssert(body: untyped): untyped</a></li> </ul> <ul class="simple nested-toc-section">exclIfIt <li><a class="reference" href="#exclIfIt.t%2CHashSet%5BT%5D%2Cuntyped" title="exclIfIt[T](set: var HashSet[T]; condition: untyped)">exclIfIt[T](set: var HashSet[T]; condition: untyped)</a></li> </ul> <ul class="simple nested-toc-section">public <li><a class="reference" href="#public.t" title="public()">public()</a></li> </ul> <ul class="simple nested-toc-section">safeConvert <li><a class="reference" href="#safeConvert.t%2CS" title="safeConvert[T: SomeInteger; S: Ordinal](value: S): T">safeConvert[T: SomeInteger; S: Ordinal](value: S): T</a></li> </ul> <ul class="simple nested-toc-section">toOpt <li><a class="reference" href="#toOpt.t%2CResult%5BT%2CE%5D" title="toOpt[T, E](self: Result[T, E]): Opt[T]">toOpt[T, E](self: Result[T, E]): Opt[T]</a></li> </ul> <ul class="simple nested-toc-section">valueOr <li><a class="reference" href="#valueOr.t%2COption%5BT%5D%2Cuntyped" title="valueOr[T](self: Option[T]; body: untyped): untyped">valueOr[T](self: Option[T]; body: untyped): untyped</a></li> </ul> <ul class="simple nested-toc-section">withValue <li><a class="reference" href="#withValue.t%2C%2Cuntyped%2Cuntyped" title="withValue[T](self: Opt[T] | Option[T]; value, body: untyped): untyped">withValue[T](self: Opt[T] | Option[T]; value, body: untyped): untyped</a></li> </ul> </ul> </li> </ul> </div> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L1" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L1" class="link-seesrc" target="_blank" >Edit</a> <div class="nine columns" id="content"> <div id="tocRoot"></div> <p class="module-desc"></p> <div class="section" id="12"> <h1><a class="toc-backref" href="#12">Procs</a></h1> <dl class="item"> <div id="capLen,seq[T],Natural" class="tohide"> <dt><pre><span class="Keyword">proc</span> <a href="#capLen%2Cseq%5BT%5D%2CNatural"><span class="Identifier">capLen</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <span class="Identifier">Natural</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> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L73" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L73" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="shortLog,openArray[byte]" class="tohide"> <dt><pre><span class="Keyword">func</span> <a href="#shortLog%2CopenArray%5Bbyte%5D"><span class="Identifier">shortLog</span></a><span class="Other">(</span><span class="Identifier">item</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">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L28" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L28" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="shortLog,string" class="tohide"> <dt><pre><span class="Keyword">func</span> <a href="#shortLog%2Cstring"><span class="Identifier">shortLog</span></a><span class="Other">(</span><span class="Identifier">item</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L40" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L40" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> </dl></div> <div class="section" id="17"> <h1><a class="toc-backref" href="#17">Macros</a></h1> <dl class="item"> <div id="withValue.m,,untyped,untyped,untyped" class="tohide"> <dt><pre><span class="Keyword">macro</span> <a href="#withValue.m%2C%2Cuntyped%2Cuntyped%2Cuntyped"><span class="Identifier">withValue</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Operator">|</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">,</span> <span class="Identifier">elseStmt</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</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> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L115" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L115" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> </dl></div> <div class="section" id="18"> <h1><a class="toc-backref" href="#18">Templates</a></h1> <dl class="item"> <div id="compilesOr.t,untyped,untyped" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#compilesOr.t%2Cuntyped%2Cuntyped"><span class="Identifier">compilesOr</span></a><span class="Other">(</span><span class="Identifier">a</span><span class="Other">,</span> <span class="Identifier">b</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L22" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L22" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="exceptionToAssert.t,untyped" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#exceptionToAssert.t%2Cuntyped"><span class="Identifier">exceptionToAssert</span></a><span class="Other">(</span><span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L77" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L77" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="exclIfIt.t,HashSet[T],untyped" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#exclIfIt.t%2CHashSet%5BT%5D%2Cuntyped"><span class="Identifier">exclIfIt</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">set</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">HashSet</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">condition</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span></pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L140" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L140" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="public.t" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#public.t"><span class="Identifier">public</span></a><span class="Other">(</span><span class="Other">)</span> {.<span class="Identifier">pragma</span>.}</pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L17" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L17" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="safeConvert.t,S" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#safeConvert.t%2CS"><span class="Identifier">safeConvert</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">SomeInteger</span><span class="Other">;</span> <span class="Identifier">S</span><span class="Other">:</span> <span class="Identifier">Ordinal</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">value</span><span class="Other">:</span> <span class="Identifier">S</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt> <dd> Converts <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> from S to <tt class="docutils literal"><span class="pre"><span class="Identifier">T</span></span></tt> iff <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> is guaranteed to be preserved. <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L66" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L66" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="toOpt.t,Result[T,E]" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#toOpt.t%2CResult%5BT%2CE%5D"><span class="Identifier">toOpt</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">E</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">,</span> <span class="Identifier">E</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span></pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L132" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L132" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="valueOr.t,Option[T],untyped" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#valueOr.t%2COption%5BT%5D%2Cuntyped"><span class="Identifier">valueOr</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt> <dd> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L125" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L125" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> <div id="withValue.t,,untyped,untyped" class="tohide"> <dt><pre><span class="Keyword">template</span> <a href="#withValue.t%2C%2Cuntyped%2Cuntyped"><span class="Identifier">withValue</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <span class="Identifier">Opt</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Operator">|</span> <span class="Identifier">Option</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">,</span> <span class="Identifier">body</span><span class="Other">:</span> <span class="Identifier">untyped</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">untyped</span></pre></dt> <dd> <p>This template provides a convenient way to work with <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> types in Nim. It allows you to execute a block of code (<tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt>) only when the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> is not empty.</p> <p><tt class="docutils literal"><span class="pre"><span class="Identifier">self</span></span></tt> is the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt> instance being checked. <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> is the variable name to be used within the <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> for the unwrapped value. <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> is a block of code that is executed only if <tt class="docutils literal"><span class="pre"><span class="Identifier">self</span></span></tt> contains a value.</p> <p>The <tt class="docutils literal"><span class="pre"><span class="Identifier">value</span></span></tt> within <tt class="docutils literal"><span class="pre"><span class="Identifier">body</span></span></tt> is automatically unwrapped from the <tt class="docutils literal"><span class="pre"><span class="Identifier">Option</span></span></tt>, making it simpler to work with without needing explicit checks or unwrapping.</p> <p>Example:</p> <p><pre class="listing"><span class="Keyword">let</span> <span class="Identifier">myOpt</span> <span class="Operator">=</span> <span class="Identifier">Opt</span><span class="Operator">.</span><span class="Identifier">some</span><span class="Punctuation">(</span><span class="DecNumber">5</span><span class="Punctuation">)</span> <span class="Identifier">myOpt</span><span class="Operator">.</span><span class="Identifier">withValue</span><span class="Punctuation">(</span><span class="Identifier">value</span><span class="Punctuation">)</span><span class="Punctuation">:</span> <span class="Identifier">echo</span> <span class="Identifier">value</span> <span class="Comment"># Will print 5</span> </pre></p> <p>Note: This is a template, and it will be inlined at the call site, offering good performance.</p> <a href="https://github.com/status-im/nim-libp2p/tree/gossipsub12/libp2p/utility.nim#L91" class="link-seesrc" target="_blank">Source</a> <a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/utility.nim#L91" class="link-seesrc" target="_blank" >Edit</a> </dd> </div> </dl></div> </div> </div> <div class="row"> <div class="twelve-columns footer"> <span class="nim-sprite"></span> <br/> <small style="color: var(--hint);">Made with Nim. Generated: 2024-06-03 19:50:36 UTC</small> </div> </div> </div> </div> </body> </html>