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

647 lines
44 KiB
HTML
Raw Blame History

<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>libp2p/vbuffer</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/vbuffer</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#VBuffer"
title="VBuffer = object
buffer*: seq[byte]
offset*: int">VBuffer</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">$
<li><a class="reference" href="#%24%2CVBuffer"
title="`$`(vb: VBuffer): string">`$`(vb: VBuffer): string</a></li>
</ul>
<ul class="simple nested-toc-section">finish
<li><a class="reference" href="#finish%2CVBuffer"
title="finish(vb: var VBuffer)">finish(vb: var VBuffer)</a></li>
</ul>
<ul class="simple nested-toc-section">high
<li><a class="reference" href="#high%2CVBuffer"
title="high(vb: VBuffer): int">high(vb: VBuffer): int</a></li>
</ul>
<ul class="simple nested-toc-section">initVBuffer
<li><a class="reference" href="#initVBuffer"
title="initVBuffer(): VBuffer">initVBuffer(): VBuffer</a></li>
<li><a class="reference" href="#initVBuffer%2CopenArray%5Bbyte%5D%2Cint"
title="initVBuffer(data: openArray[byte]; offset = 0): VBuffer">initVBuffer(data: openArray[byte]; offset = 0): VBuffer</a></li>
<li><a class="reference" href="#initVBuffer%2Cseq%5Bbyte%5D%2Cint"
title="initVBuffer(data: seq[byte]; offset = 0): VBuffer">initVBuffer(data: seq[byte]; offset = 0): VBuffer</a></li>
</ul>
<ul class="simple nested-toc-section">len
<li><a class="reference" href="#len%2CVBuffer"
title="len(vb: VBuffer): int">len(vb: VBuffer): int</a></li>
</ul>
<ul class="simple nested-toc-section">peekArray
<li><a class="reference" href="#peekArray%2CVBuffer%2CopenArray%5BT%5D"
title="peekArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int">peekArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int</a></li>
</ul>
<ul class="simple nested-toc-section">peekSeq
<li><a class="reference" href="#peekSeq%2CVBuffer%2CT"
title="peekSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int">peekSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int</a></li>
</ul>
<ul class="simple nested-toc-section">peekVarint
<li><a class="reference" href="#peekVarint%2CVBuffer%2CLPSomeUVarint"
title="peekVarint(vb: var VBuffer; value: var LPSomeUVarint): int">peekVarint(vb: var VBuffer; value: var LPSomeUVarint): int</a></li>
</ul>
<ul class="simple nested-toc-section">readArray
<li><a class="reference" href="#readArray%2CVBuffer%2CopenArray%5BT%5D"
title="readArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int">readArray[T: char | byte](vb: var VBuffer; value: var openArray[T]): int</a></li>
</ul>
<ul class="simple nested-toc-section">readSeq
<li><a class="reference" href="#readSeq%2CVBuffer%2CT"
title="readSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int">readSeq[T: string | seq[byte]](vb: var VBuffer; value: var T): int</a></li>
</ul>
<ul class="simple nested-toc-section">readVarint
<li><a class="reference" href="#readVarint%2CVBuffer%2CLPSomeUVarint"
title="readVarint(vb: var VBuffer; value: var LPSomeUVarint): int">readVarint(vb: var VBuffer; value: var LPSomeUVarint): int</a></li>
</ul>
<ul class="simple nested-toc-section">writeArray
<li><a class="reference" href="#writeArray%2CVBuffer%2CopenArray%5BT%5D"
title="writeArray[T: byte | char](vb: var VBuffer; value: openArray[T])">writeArray[T: byte | char](vb: var VBuffer; value: openArray[T])</a></li>
</ul>
<ul class="simple nested-toc-section">writeLPVarint
<li><a class="reference" href="#writeLPVarint%2CVBuffer%2CLPSomeUVarint"
title="writeLPVarint(vb: var VBuffer; value: LPSomeUVarint)">writeLPVarint(vb: var VBuffer; value: LPSomeUVarint)</a></li>
</ul>
<ul class="simple nested-toc-section">writePBVarint
<li><a class="reference" href="#writePBVarint%2CVBuffer%2CPBSomeUVarint"
title="writePBVarint(vb: var VBuffer; value: PBSomeUVarint)">writePBVarint(vb: var VBuffer; value: PBSomeUVarint)</a></li>
</ul>
<ul class="simple nested-toc-section">writeSeq
<li><a class="reference" href="#writeSeq%2CVBuffer%2CopenArray%5BT%5D"
title="writeSeq[T: byte | char](vb: var VBuffer; value: openArray[T])">writeSeq[T: byte | char](vb: var VBuffer; value: openArray[T])</a></li>
</ul>
<ul class="simple nested-toc-section">writeVarint
<li><a class="reference" href="#writeVarint%2CVBuffer%2CLPSomeUVarint"
title="writeVarint(vb: var VBuffer; value: LPSomeUVarint)">writeVarint(vb: var VBuffer; value: LPSomeUVarint)</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">isEmpty
<li><a class="reference" href="#isEmpty.t%2CVBuffer"
title="isEmpty(vb: VBuffer): bool">isEmpty(vb: VBuffer): bool</a></li>
</ul>
<ul class="simple nested-toc-section">isEnough
<li><a class="reference" href="#isEnough.t%2CVBuffer%2Cint"
title="isEnough(vb: VBuffer; length: int): bool">isEnough(vb: VBuffer; length: int): bool</a></li>
</ul>
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">This module implements variable buffer.</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="varint.html">varint</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="VBuffer" class="tohide">
<dt><pre><a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">buffer</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>
<span class="Identifier">offset</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">int</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L17"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L17" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="$,VBuffer" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#%24%2CVBuffer"><span class="Identifier">`$`</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Return hexadecimal string representation of buffer <tt class="docutils literal"><span class="pre">vb</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L182"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L182" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="finish,VBuffer" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#finish%2CVBuffer"><span class="Identifier">finish</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><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>
Finishes <tt class="docutils literal"><span class="pre">vb</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L100"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L100" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="high,VBuffer" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#high%2CVBuffer"><span class="Identifier">high</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</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 class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Returns number of bytes left in buffer <tt class="docutils literal"><span class="pre">vb</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L29"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="initVBuffer" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#initVBuffer"><span class="Identifier">initVBuffer</span></a><span class="Other">(</span><span class="Other">)</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Initialize empty VBuffer.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L51"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L51" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="initVBuffer,openArray[byte],int" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#initVBuffer%2CopenArray%5Bbyte%5D%2Cint"><span class="Identifier">initVBuffer</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="Identifier">offset</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Initialize VBuffer with copy of <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L44"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="initVBuffer,seq[byte],int" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#initVBuffer%2Cseq%5Bbyte%5D%2Cint"><span class="Identifier">initVBuffer</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">offset</span> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">)</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Initialize VBuffer with shallow copy of <tt class="docutils literal"><span class="pre">data</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L39"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L39" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="len,VBuffer" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#len%2CVBuffer"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</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 class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
Returns number of bytes left in buffer <tt class="docutils literal"><span class="pre">vb</span></tt>.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L34"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L34" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="peekArray,VBuffer,openArray[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#peekArray%2CVBuffer%2CopenArray%5BT%5D"><span class="Identifier">peekArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">char</span> <span class="Operator">|</span> <span class="Identifier">byte</span><span class="Other">]</span><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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Peek array from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>This procedure will not adjust internal offset.</p>
<p>Returns number of bytes peeked from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L141"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L141" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="peekSeq,VBuffer,T" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#peekSeq%2CVBuffer%2CT"><span class="Identifier">peekSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Operator">|</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">]</span><span class="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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Peek length prefixed array from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>This procedure will not adjust internal offset.</p>
<p>Returns number of bytes peeked from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L119"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L119" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="peekVarint,VBuffer,LPSomeUVarint" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#peekVarint%2CVBuffer%2CLPSomeUVarint"><span class="Identifier">peekVarint</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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="varint.html#LPSomeUVarint"><span class="Identifier">LPSomeUVarint</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>.}</pre></dt>
<dd>
<p>Peek unsigned integer from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>This procedure will not adjust internal offset.</p>
<p>Returns number of bytes peeked from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L104"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L104" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="readArray,VBuffer,openArray[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#readArray%2CVBuffer%2CopenArray%5BT%5D"><span class="Identifier">readArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">char</span> <span class="Operator">|</span> <span class="Identifier">byte</span><span class="Other">]</span><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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.
<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Read array from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>Returns number of bytes consumed from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L173"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L173" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="readSeq,VBuffer,T" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#readSeq%2CVBuffer%2CT"><span class="Identifier">readSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">string</span> <span class="Operator">|</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">]</span><span class="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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.
<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Read length prefixed array from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>Returns number of bytes consumed from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L163"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L163" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="readVarint,VBuffer,LPSomeUVarint" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#readVarint%2CVBuffer%2CLPSomeUVarint"><span class="Identifier">readVarint</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">value</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="varint.html#LPSomeUVarint"><span class="Identifier">LPSomeUVarint</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span class="Identifier">inline</span><span class="Other">,</span>
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Read unsigned integer from buffer <tt class="docutils literal"><span class="pre">vb</span></tt> and store result to <tt class="docutils literal"><span class="pre">value</span></tt>.</p>
<p>Returns number of bytes consumed from <tt class="docutils literal"><span class="pre">vb</span></tt> or <tt class="docutils literal"><span class="pre">-1</span></tt> on error.</p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L155"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L155" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="writeArray,VBuffer,openArray[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#writeArray%2CVBuffer%2CopenArray%5BT%5D"><span class="Identifier">writeArray</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">byte</span> <span class="Operator">|</span> <span class="Identifier">char</span><span class="Other">]</span><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">value</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</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>
Write array <tt class="docutils literal"><span class="pre">value</span></tt> to buffer <tt class="docutils literal"><span class="pre">vb</span></tt>, value will NOT be prefixed with varint length of the array.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L92"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L92" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="writeLPVarint,VBuffer,LPSomeUVarint" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#writeLPVarint%2CVBuffer%2CLPSomeUVarint"><span class="Identifier">writeLPVarint</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">value</span><span class="Other">:</span> <a href="varint.html#LPSomeUVarint"><span class="Identifier">LPSomeUVarint</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>.}</pre></dt>
<dd>
Write <tt class="docutils literal"><span class="pre">value</span></tt> as variable unsigned integer.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L65"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="writePBVarint,VBuffer,PBSomeUVarint" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#writePBVarint%2CVBuffer%2CPBSomeUVarint"><span class="Identifier">writePBVarint</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">value</span><span class="Other">:</span> <a href="varint.html#PBSomeUVarint"><span class="Identifier">PBSomeUVarint</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>.}</pre></dt>
<dd>
Write <tt class="docutils literal"><span class="pre">value</span></tt> as variable unsigned integer.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L55"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L55" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="writeSeq,VBuffer,openArray[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#writeSeq%2CVBuffer%2CopenArray%5BT%5D"><span class="Identifier">writeSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">byte</span> <span class="Operator">|</span> <span class="Identifier">char</span><span class="Other">]</span><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">value</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</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>
Write array <tt class="docutils literal"><span class="pre">value</span></tt> to buffer <tt class="docutils literal"><span class="pre">vb</span></tt>, value will be prefixed with varint length of the array.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L79"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L79" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="writeVarint,VBuffer,LPSomeUVarint" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#writeVarint%2CVBuffer%2CLPSomeUVarint"><span class="Identifier">writeVarint</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">value</span><span class="Other">:</span> <a href="varint.html#LPSomeUVarint"><span class="Identifier">LPSomeUVarint</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>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L76"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L76" 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="isEmpty.t,VBuffer" class="tohide">
<dt><pre><span class="Keyword">template</span> <a href="#isEmpty.t%2CVBuffer"><span class="Identifier">isEmpty</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
<dd>
Returns <tt class="docutils literal"><span class="pre">true</span></tt> if buffer <tt class="docutils literal"><span class="pre">vb</span></tt> is empty.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L21"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="isEnough.t,VBuffer,int" class="tohide">
<dt><pre><span class="Keyword">template</span> <a href="#isEnough.t%2CVBuffer%2Cint"><span class="Identifier">isEnough</span></a><span class="Other">(</span><span class="Identifier">vb</span><span class="Other">:</span> <a href="vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span></pre></dt>
<dd>
Returns <tt class="docutils literal"><span class="pre">true</span></tt> if buffer <tt class="docutils literal"><span class="pre">vb</span></tt> holds at least <tt class="docutils literal"><span class="pre">length</span></tt> bytes.
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/tcptrans-cleanup/libp2p/vbuffer.nim#L25"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/vbuffer.nim#L25" 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-05-09 15:09:51 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink