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/ym-exhierarchy/libp2p/stream/bufferstream.html

524 lines
67 KiB
HTML
Raw Normal View History

update docs for ym-exhierarchy
2024-03-02 21:25:25 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>libp2p/stream/bufferstream</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/stream/bufferstream</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="#BufferStream"
title="BufferStream = ref object of Connection
readQueue*: AsyncQueue[seq[byte]]
readBuf*: StreamSeq
pushing*: bool
reading*: bool
pushedEof*: bool
returnedEof*: bool">BufferStream</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#10" id="60">Consts</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#BufferStreamTrackerName"
title="BufferStreamTrackerName = &quot;BufferStream&quot;">BufferStreamTrackerName</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">len
<li><a class="reference" href="#len%2CBufferStream"
title="len(s: BufferStream): int">len(s: BufferStream): int</a></li>
</ul>
<ul class="simple nested-toc-section">new
<li><a class="reference" href="#new%2Ctypedesc%5BBufferStream%5D%2CDuration"
title="new(T: typedesc[BufferStream]; timeout: Duration = DefaultConnectionTimeout): T:type">new(T: typedesc[BufferStream]; timeout: Duration = DefaultConnectionTimeout): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">shortLog
<li><a class="reference" href="#shortLog%2CBufferStream"
title="shortLog(s: BufferStream): auto">shortLog(s: BufferStream): auto</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#14" id="64">Methods</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">atEof
<li><a class="reference" href="#atEof.e%2CBufferStream"
title="atEof(s: BufferStream): bool">atEof(s: BufferStream): bool</a></li>
</ul>
<ul class="simple nested-toc-section">closeImpl
<li><a class="reference" href="#closeImpl.e%2CBufferStream"
title="closeImpl(s: BufferStream): Future[void]">closeImpl(s: BufferStream): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">initStream
<li><a class="reference" href="#initStream.e%2CBufferStream"
title="initStream(s: BufferStream)">initStream(s: BufferStream)</a></li>
</ul>
<ul class="simple nested-toc-section">pushData
<li><a class="reference" href="#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D"
title="pushData(s: BufferStream; data: seq[byte]): Future[void]">pushData(s: BufferStream; data: seq[byte]): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">pushEof
<li><a class="reference" href="#pushEof.e%2CBufferStream"
title="pushEof(s: BufferStream): Future[void]">pushEof(s: BufferStream): Future[void]</a></li>
</ul>
<ul class="simple nested-toc-section">readOnce
<li><a class="reference" href="#readOnce.e%2CBufferStream%2Cpointer%2Cint"
title="readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]">readOnce(s: BufferStream; pbytes: pointer; nbytes: int): Future[int]</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">formatItIMPL
<li><a class="reference" href="#formatItIMPL.t%2CBufferStream"
title="formatItIMPL(it: BufferStream): auto">formatItIMPL(it: BufferStream): auto</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.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="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="connection.html">connection</a>, <a class="reference external" href="streamseq.html">streamseq</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="BufferStream" class="tohide">
<dt><pre><a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a> <span class="Other">=</span> <span class="Keyword">ref</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="connection.html#Connection"><span class="Identifier">Connection</span></a>
<span class="Identifier">readQueue</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">AsyncQueue</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">readBuf</span><span class="Operator">*</span><span class="Other">:</span> <a href="streamseq.html#StreamSeq"><span class="Identifier">StreamSeq</span></a>
<span class="Identifier">pushing</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">reading</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">pushedEof</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
<span class="Identifier">returnedEof</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">bool</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L27"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L27" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="10">
<h1><a class="toc-backref" href="#10">Consts</a></h1>
<dl class="item">
<div id="BufferStreamTrackerName" class="tohide">
<dt><pre><a href="bufferstream.html#BufferStreamTrackerName"><span class="Identifier">BufferStreamTrackerName</span></a> <span class="Other">=</span> <span class="StringLit">&quot;BufferStream&quot;</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L24"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L24" 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="len,BufferStream" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#len%2CBufferStream"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L44"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L44" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="new,typedesc[BufferStream],Duration" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#new%2Ctypedesc%5BBufferStream%5D%2CDuration"><span class="Identifier">new</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="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">timeout</span><span class="Other">:</span> <span class="Identifier">Duration</span> <span class="Other">=</span> <span class="Identifier">DefaultConnectionTimeout</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</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/ym-exhierarchy/libp2p/stream/bufferstream.nim#L57"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L57" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="shortLog,BufferStream" class="tohide">
<dt><pre><span class="Keyword">func</span> <a href="#shortLog%2CBufferStream"><span class="Identifier">shortLog</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</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>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L35"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L35" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="14">
<h1><a class="toc-backref" href="#14">Methods</a></h1>
<dl class="item">
<div id="atEof.e,BufferStream" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#atEof.e%2CBufferStream"><span class="Identifier">atEof</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L108"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L108" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="closeImpl.e,BufferStream" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#closeImpl.e%2CBufferStream"><span class="Identifier">closeImpl</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
close the stream and clear the buffer
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L176"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L176" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="initStream.e,BufferStream" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#initStream.e%2CBufferStream"><span class="Identifier">initStream</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</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="Identifier">TimeEffect</span><span class="Other">,</span> <span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L47"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L47" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="pushData.e,BufferStream,seq[byte]" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#pushData.e%2CBufferStream%2Cseq%5Bbyte%5D"><span class="Identifier">pushData</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</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="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span>
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
<p>Write bytes to internal read buffer, use this to fill up the buffer with data.</p>
<p><tt class="docutils literal"><span class="pre"><span class="Identifier">pushTo</span></span></tt> will block if the queue is full, thus maintaining backpressure. </p>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L65"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L65" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="pushEof.e,BufferStream" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#pushEof.e%2CBufferStream"><span class="Identifier">pushEof</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">]</span> {.<span class="Identifier">base</span><span class="Other">,</span> <span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span>
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L90"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L90" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="readOnce.e,BufferStream,pointer,int" class="tohide">
<dt><pre><span class="Keyword">method</span> <a href="#readOnce.e%2CBufferStream%2Cpointer%2Cint"><span class="Identifier">readOnce</span></a><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">;</span> <span class="Identifier">pbytes</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">nbytes</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Future</span><span class="Other">[</span><span class="Identifier">int</span><span class="Other">]</span> {.
<span class="Identifier">stackTrace</span><span class="Other">:</span> <span class="DecNumber">false</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">gcsafe</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <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="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L114"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L114" 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="formatItIMPL.t,BufferStream" class="tohide">
<dt><pre><span class="Keyword">template</span> <a href="#formatItIMPL.t%2CBufferStream"><span class="Identifier">formatItIMPL</span></a><span class="Other">(</span><span class="Identifier">it</span><span class="Other">:</span> <a href="bufferstream.html#BufferStream"><span class="Identifier">BufferStream</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">auto</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/ym-exhierarchy/libp2p/stream/bufferstream.nim#L42"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/bufferstream.nim#L42" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="lpstream.html#newLPStreamWriteError,ref.CatchableError"><span class="Identifier">newLPStreamWriteError</span></a>, <a href="../multiaddress.html#DNS_OR_IP"><span class="Identifier">DNS_OR_IP</span></a>, <a href="../protobuf/minprotobuf.html#ProtoHeader"><span class="Identifier">ProtoHeader</span></a>, <a href="../utility.html#shortLog,string"><span class="Identifier">shortLog</span></a>, <a href="../signed_envelope.html#init,typedesc[SignedPayload[T]],PrivateKey,T"><span class="Identifier">init</span></a>, <a href="../crypto/crypto.html#random,typedesc[KeyPair],HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../multiaddress.html#UDP_DNS"><span class="Identifier">UDP_DNS</span></a>, <a href="../crypto/crypto.html#$"><span class="Identifier">$</span></a>, <a href="../peerid.html#<=.t,PeerId,PeerId"><span class="Identifier">&lt;=</span></a>, <a href="../multiaddress.html#MaError"><span class="Identifier">MaError</span></a>, <a href="../crypto/ecnist.html#ephemeral,string,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="../routing_record.html#decode,typedesc[PeerRecord],seq[byte]"><span class="Identifier">decode</span></a>, <a href="../multiaddress.html#MaPatternOp"><span class="Identifier">MaPatternOp</span></a>, <a href="../crypto/crypto.html#==,PublicKey,PublicKey"><span class="Identifier">==</span></a>, <a href="../multiaddress.html#WS_DNS"><span class="Identifier">WS_DNS</span></a>, <a href="../vbuffer.html#initVBuffer,seq[byte],int"><span class="Identifier">initVBuffer</span></a>, <a href="../protobuf/minprotobuf.html#getProtoHeader.t,ProtoField"><span class="Identifier">getProtoHeader</span></a>, <a href="lpstream.html#MaxSizeError"><span class="Identifier">MaxSizeError</span></a>, <a href="../protobuf/minprotobuf.html#ProtoFlags"><span class="Identifier">ProtoFlags</span></a>, <a href="../protobuf/minprotobuf.html#getLen.t,ProtoBuffer"><span class="Identifier">getLen</span></a>, <a href="../crypto/ecnist.html#ECDHEScheme"><span class="Identifier">ECDHEScheme</span></a>, <a href="../peerinfo.html#shortLog,PeerInfo"><span class="Identifier">shortLog</span></a>, <a href="../peerid.html#init,PeerId,openArray[byte]"><span class="Identifier">init</span></a>, <a href="../crypto/crypto.html#init,typedesc[PublicKey],"><span class="Identifier">init</span></a>, <a href="lpstream.html#closed.e,LPStream"><span class="Identifier">closed</span></a>, <a href="../multiaddress.html#[],MultiAddress,MultiCodec"><span class="Identifier">[]</span></a>, <a href="../crypto/crypto.html#macOpenArray.t,Secret,int"><span class="Identifier">macOpenArray</span></a>, <a href="../crypto/crypto.html#random,typedesc[KeyPair],PKScheme,HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="../multiaddress.html#init,typedesc[MultiAddress],MultiCodec,PeerId"><span class="Identifier">init</span></a>, <a href="../vbuffer.html#VBuffer"><span class="Identifier">VBuffer</span></a>, <a href="../crypto/crypto.html#Secret"><span class="Identifier">Secret</span></a>, <a href="../vbuffer.html#peekVarint,VBuffer,LPSomeUVarint"><span class="Identifier">peekVarint</span></a>, <a href="../peerid.html#random,typedesc[PeerId]"><span class="Identifier">random</span></a>, <a href="../vbuffer.html#$,VBuffer"><span class="Identifier">$</span></a>, <a href="../multiaddress.html#validate,MultiAddress"><span class="Identifier">validate</span></a>, <a href="../multiaddress.html#mapOr,varargs[MaPattern]"><span class="Identifier">mapOr</span></a>, <a href="../peerid.html#init,typedesc[PeerId],PrivateKey"><span class="Identifier">init</span></a>, <a href="../multiaddress.html#bytes,MultiAddress"><span class="Identifier">bytes</span></a>, <a href="../peerid.html#maxInlineKeyLength"><span class="Identifier">maxInlineKeyLength</span></a>, <a href="../multiaddress.html#TranscoderDNS"><span class="Identifier">TranscoderDNS</span></a>, <a href="../multiaddress.html#QUIC"><span class="Identifier">QUIC</span></a>, <a href="../multiaddress.html#[],MultiAddress,HSlice"><span class="Identifier">[]</span></a>, <a href="../
</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-03-02 21:25:16 UTC</small>
</div>
</div>
</div>
</div>
</body>
</html>