2023-12-18 18:06:09 +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/lpstream< / 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/lpstream< / 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 = "#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 = "#Direction"
title="Direction {.pure.} = enum
In, Out">Direction< / a > < / li >
< li > < a class = "reference" href = "#InvalidVarintError"
title="InvalidVarintError = object of LPStreamError">InvalidVarintError< / a > < / li >
< li > < a class = "reference" href = "#LPStream"
title="LPStream = ref object of RootObj
closeEvent*: AsyncEvent
isClosed*: bool
isEof*: bool
objName*: string
oid*: Oid
dir*: Direction
closedWithEOF: bool">LPStream< / a > < / li >
< li > < a class = "reference" href = "#LPStreamClosedError"
title="LPStreamClosedError = object of LPStreamEOFError">LPStreamClosedError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamConnDownError"
title="LPStreamConnDownError = object of LPStreamEOFError">LPStreamConnDownError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamEOFError"
title="LPStreamEOFError = object of LPStreamError">LPStreamEOFError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamError"
title="LPStreamError = object of LPError">LPStreamError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamIncompleteError"
title="LPStreamIncompleteError = object of LPStreamError">LPStreamIncompleteError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamLimitError"
title="LPStreamLimitError = object of LPStreamError">LPStreamLimitError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamRemoteClosedError"
title="LPStreamRemoteClosedError = object of LPStreamEOFError">LPStreamRemoteClosedError< / a > < / li >
< li > < a class = "reference" href = "#LPStreamResetError"
title="LPStreamResetError = object of LPStreamEOFError">LPStreamResetError< / a > < / li >
< li > < a class = "reference" href = "#MaxSizeError"
title="MaxSizeError = object of LPStreamError">MaxSizeError< / a > < / li >
< li > < a class = "reference" href = "#StreamTracker"
title="StreamTracker = ref object of TrackerBase
opened*: uint64
closed*: uint64">StreamTracker< / 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 = "#Eof"
title="Eof = []">Eof< / a > < / li >
< li > < a class = "reference" href = "#LPStreamTrackerName"
title="LPStreamTrackerName = " LPStream" ">LPStreamTrackerName< / 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" > closeWithEOF
< li > < a class = "reference" href = "#closeWithEOF%2CLPStream"
2024-04-29 13:39:28 +00:00
title="closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]">closeWithEOF(s: LPStream): InternalRaisesFuture[void, void]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > join
< li > < a class = "reference" href = "#join%2CLPStream"
2024-04-29 13:39:28 +00:00
title="join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]">join(s: LPStream): InternalRaisesFuture[void, (CancelledError,)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamClosedError
< li > < a class = "reference" href = "#newLPStreamClosedError"
title="newLPStreamClosedError(): ref LPStreamClosedError">newLPStreamClosedError(): ref LPStreamClosedError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamConnDownError
< li > < a class = "reference" href = "#newLPStreamConnDownError%2Cref.Exception"
title="newLPStreamConnDownError(parentException: ref Exception = nil): ref LPStreamConnDownError">newLPStreamConnDownError(parentException: ref Exception = nil): ref LPStreamConnDownError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamEOFError
< li > < a class = "reference" href = "#newLPStreamEOFError"
title="newLPStreamEOFError(): ref LPStreamEOFError">newLPStreamEOFError(): ref LPStreamEOFError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamIncompleteError
< li > < a class = "reference" href = "#newLPStreamIncompleteError"
title="newLPStreamIncompleteError(): ref LPStreamIncompleteError">newLPStreamIncompleteError(): ref LPStreamIncompleteError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamLimitError
< li > < a class = "reference" href = "#newLPStreamLimitError"
title="newLPStreamLimitError(): ref LPStreamLimitError">newLPStreamLimitError(): ref LPStreamLimitError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamRemoteClosedError
< li > < a class = "reference" href = "#newLPStreamRemoteClosedError"
title="newLPStreamRemoteClosedError(): ref LPStreamRemoteClosedError">newLPStreamRemoteClosedError(): ref LPStreamRemoteClosedError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > newLPStreamResetError
< li > < a class = "reference" href = "#newLPStreamResetError"
title="newLPStreamResetError(): ref LPStreamResetError">newLPStreamResetError(): ref LPStreamResetError< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > readExactly
< li > < a class = "reference" href = "#readExactly%2CLPStream%2Cpointer%2Cint"
2024-04-29 13:39:28 +00:00
title="readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
void, (CancelledError, LPStreamError)]">readExactly(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[
void, (CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > readLine
< li > < a class = "reference" href = "#readLine%2CLPStream%2Cint%2Cstring"
2024-04-29 13:39:28 +00:00
title="readLine(s: LPStream; limit = 0; sep = " \r\n" ): InternalRaisesFuture[string,
(CancelledError, LPStreamError)]">readLine(s: LPStream; limit = 0; sep = " \r\n" ): InternalRaisesFuture[string,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > readLp
< li > < a class = "reference" href = "#readLp%2CLPStream%2Cint"
2024-04-29 13:39:28 +00:00
title="readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
(CancelledError, LPStreamError)]">readLp(s: LPStream; maxSize: int): InternalRaisesFuture[seq[byte],
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > readVarint
< li > < a class = "reference" href = "#readVarint%2CLPStream"
2024-04-29 13:39:28 +00:00
title="readVarint(conn: LPStream): InternalRaisesFuture[uint64,
(CancelledError, LPStreamError)]">readVarint(conn: LPStream): InternalRaisesFuture[uint64,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > shortLog
< li > < a class = "reference" href = "#shortLog%2CLPStream"
title="shortLog(s: LPStream): auto">shortLog(s: LPStream): auto< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > write
< li > < a class = "reference" href = "#write%2CLPStream%2Cstring"
2024-04-29 13:39:28 +00:00
title="write(s: LPStream; msg: string): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]">write(s: LPStream; msg: string): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > writeLp
< li > < a class = "reference" href = "#writeLp%2CLPStream%2CopenArray%5Bbyte%5D"
2024-04-29 13:39:28 +00:00
title="writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]">writeLp(s: LPStream; msg: openArray[byte]): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< li > < a class = "reference" href = "#writeLp%2CLPStream%2Cstring"
2024-04-29 13:39:28 +00:00
title="writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]">writeLp(s: LPStream; msg: string): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / 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%2CLPStream"
title="atEof(s: LPStream): bool">atEof(s: LPStream): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > close
< li > < a class = "reference" href = "#close.e%2CLPStream"
2024-04-29 13:39:28 +00:00
title="close(s: LPStream): InternalRaisesFuture[void, void]">close(s: LPStream): InternalRaisesFuture[void, void]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > closed
< li > < a class = "reference" href = "#closed.e%2CLPStream"
title="closed(s: LPStream): bool">closed(s: LPStream): bool< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > closeImpl
< li > < a class = "reference" href = "#closeImpl.e%2CLPStream"
2024-04-29 13:39:28 +00:00
title="closeImpl(s: LPStream): InternalRaisesFuture[void, void]">closeImpl(s: LPStream): InternalRaisesFuture[void, void]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > initStream
< li > < a class = "reference" href = "#initStream.e%2CLPStream"
title="initStream(s: LPStream)">initStream(s: LPStream)< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > readOnce
< li > < a class = "reference" href = "#readOnce.e%2CLPStream%2Cpointer%2Cint"
2024-04-29 13:39:28 +00:00
title="readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
(CancelledError, LPStreamError)]">readOnce(s: LPStream; pbytes: pointer; nbytes: int): InternalRaisesFuture[int,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / ul >
< ul class = "simple nested-toc-section" > write
< li > < a class = "reference" href = "#write.e%2CLPStream%2Cseq%5Bbyte%5D"
2024-04-29 13:39:28 +00:00
title="write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]">write(s: LPStream; msg: seq[byte]): InternalRaisesFuture[void,
(CancelledError, LPStreamError)]< / a > < / li >
2023-12-18 18:06:09 +00:00
< / 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%2CLPStream"
title="formatItIMPL(it: LPStream): auto">formatItIMPL(it: LPStream): 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 >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L1"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > Length Prefixed stream implementation< / p >
< div class = "section" id = "6" >
< h1 > < a class = "toc-backref" href = "#6" > Imports< / a > < / h1 >
< dl class = "item" >
< a class = "reference external" href = "../varint.html" > ../varint< / a > , < a class = "reference external" href = "../peerinfo.html" > ../peerinfo< / a > , < a class = "reference external" href = "../multiaddress.html" > ../multiaddress< / a > , < a class = "reference external" href = "../utility.html" > ../utility< / a > , < a class = "reference external" href = "../errors.html" > ../errors< / a >
< / dl > < / div >
< div class = "section" id = "7" >
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "Direction" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#Direction" > < span class = "Identifier" > Direction< / span > < / a > {.< span class = "Identifier" > pure< / span > .} < span class = "Other" > =< / span > < span class = "Keyword" > enum< / span >
< span class = "Identifier" > In< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > Out< / span > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L39"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L39" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "InvalidVarintError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#InvalidVarintError" > < span class = "Identifier" > InvalidVarintError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L68"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L68" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStream" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > ref< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < span class = "Identifier" > RootObj< / span >
< span class = "Identifier" > closeEvent< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > AsyncEvent< / span >
< span class = "Identifier" > isClosed< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span >
< span class = "Identifier" > isEof< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span >
< span class = "Identifier" > objName< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span >
< span class = "Identifier" > oid< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Oid< / span >
< span class = "Identifier" > dir< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#Direction" > < span class = "Identifier" > Direction< / span > < / a >
< span class = "Identifier" > closedWithEOF< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span >
< / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L42"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L42" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "LPStreamClosedError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamClosedError" > < span class = "Identifier" > LPStreamClosedError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L64"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L64" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStreamConnDownError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamConnDownError" > < span class = "Identifier" > LPStreamConnDownError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L66"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L66" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStreamEOFError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L54"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L54" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStreamError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "../errors.html#LPError" > < span class = "Identifier" > LPError< / span > < / a > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L51"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L51" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "LPStreamIncompleteError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamIncompleteError" > < span class = "Identifier" > LPStreamIncompleteError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L52"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L52" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "LPStreamLimitError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamLimitError" > < span class = "Identifier" > LPStreamLimitError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L53"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L53" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStreamRemoteClosedError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamRemoteClosedError" > < span class = "Identifier" > LPStreamRemoteClosedError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L65"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L65" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "LPStreamResetError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamResetError" > < span class = "Identifier" > LPStreamResetError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L63"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L63" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "MaxSizeError" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#MaxSizeError" > < span class = "Identifier" > MaxSizeError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L69"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L69" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "StreamTracker" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#StreamTracker" > < span class = "Identifier" > StreamTracker< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > ref< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < span class = "Identifier" > TrackerBase< / span >
< span class = "Identifier" > opened< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > uint64< / span >
< span class = "Identifier" > closed< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > uint64< / span >
< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L71"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L71" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "10" >
< h1 > < a class = "toc-backref" href = "#10" > Consts< / a > < / h1 >
< dl class = "item" >
< div id = "Eof" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#Eof" > < span class = "Identifier" > Eof< / span > < / a > < span class = "Other" > =< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L36"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L36" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "LPStreamTrackerName" class = "tohide" >
< dt > < pre > < a href = "lpstream.html#LPStreamTrackerName" > < span class = "Identifier" > LPStreamTrackerName< / span > < / a > < span class = "Other" > =< / span > < span class = "StringLit" > " LPStream" < / span > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L35"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L35" 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 = "closeWithEOF,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#closeWithEOF%2CLPStream" > < span class = "Identifier" > closeWithEOF< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< p > Close the stream and wait for EOF - use this with half-closed streams where an EOF is expected to arrive from the other end.< / p >
< p > Note - this should only be used when there has been an in-protocol notification that no more data will arrive and that the only thing left for the other end to do is to close the stream gracefully.< / p >
< p > In particular, it must not be used when there is another concurrent read ongoing (which may be the case during cancellations)! < / p >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L314"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L314" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "join,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#join%2CLPStream" > < span class = "Identifier" > join< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span > < span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.
< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
2024-04-29 13:39:28 +00:00
2023-12-18 18:06:09 +00:00
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L119"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L119" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamClosedError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamClosedError" > < span class = "Identifier" > newLPStreamClosedError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamClosedError" > < span class = "Identifier" > LPStreamClosedError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L87"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L87" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamConnDownError,ref.Exception" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamConnDownError%2Cref.Exception" > < span class = "Identifier" > newLPStreamConnDownError< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > parentException< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < span class = "Identifier" > Exception< / span > < span class = "Other" > =< / span > < span class = "Keyword" > nil< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamConnDownError" > < span class = "Identifier" > LPStreamConnDownError< / span > < / a > {.
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L93"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L93" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamEOFError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamEOFError" > < span class = "Identifier" > newLPStreamEOFError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamEOFError" > < span class = "Identifier" > LPStreamEOFError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L81"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L81" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamIncompleteError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamIncompleteError" > < span class = "Identifier" > newLPStreamIncompleteError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamIncompleteError" > < span class = "Identifier" > LPStreamIncompleteError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L75"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L75" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamLimitError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamLimitError" > < span class = "Identifier" > newLPStreamLimitError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamLimitError" > < span class = "Identifier" > LPStreamLimitError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L78"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L78" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamRemoteClosedError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamRemoteClosedError" > < span class = "Identifier" > newLPStreamRemoteClosedError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamRemoteClosedError" > < span class = "Identifier" > LPStreamRemoteClosedError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L90"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L90" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "newLPStreamResetError" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#newLPStreamResetError" > < span class = "Identifier" > newLPStreamResetError< / span > < / a > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Keyword" > ref< / span > < a href = "lpstream.html#LPStreamResetError" > < span class = "Identifier" > LPStreamResetError< / span > < / a > {.< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L84"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L84" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "readExactly,LPStream,pointer,int" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#readExactly%2CLPStream%2Cpointer%2Cint" > < span class = "Identifier" > readExactly< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / 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" > InternalRaisesFuture< / span > < span class = "Other" > [< / span >
< span class = "Identifier" > void< / span > < span class = "Other" > ,< / span > < span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
Waits for < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > nbytes< / span > < / span > < / tt > to be available, then read them and return them
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L144"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L144" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "readLine,LPStream,int,string" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#readLine%2CLPStream%2Cint%2Cstring" > < span class = "Identifier" > readLine< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > limit< / span > < span class = "Other" > =< / span > < span class = "DecNumber" > 0< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > sep< / span > < span class = "Other" > =< / span > < span class = "StringLit" > " \r\n" < / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span >
< span class = "Identifier" > string< / span > < span class = "Other" > ,< / span > < span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
Reads up to < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > limit< / span > < / span > < / tt > bytes are read, or a < tt class = "docutils literal" > < span class = "pre" > < span class = "Identifier" > sep< / span > < / span > < / tt > is found
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L182"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L182" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "readLp,LPStream,int" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#readLp%2CLPStream%2Cint" > < span class = "Identifier" > readLp< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > maxSize< / span > < span class = "Other" > :< / span > < span class = "Identifier" > int< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / 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" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
read length prefixed msg, with the length encoded as a varint
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L231"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L231" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "readVarint,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#readVarint%2CLPStream" > < span class = "Identifier" > readVarint< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > conn< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > uint64< / span > < span class = "Other" > ,< / span >
< span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > RootEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L210"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L210" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "shortLog,LPStream" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#shortLog%2CLPStream" > < span class = "Identifier" > shortLog< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L100"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L100" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "write,LPStream,string" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#write%2CLPStream%2Cstring" > < span class = "Identifier" > write< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > msg< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span >
< span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L278"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L278" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "writeLp,LPStream,openArray[byte]" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#writeLp%2CLPStream%2CopenArray%5Bbyte%5D" > < span class = "Identifier" > writeLp< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > msg< / 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" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span >
< span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
2024-04-29 13:39:28 +00:00
2023-12-18 18:06:09 +00:00
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L259"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L259" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "writeLp,LPStream,string" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#writeLp%2CLPStream%2Cstring" > < span class = "Identifier" > writeLp< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > msg< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span >
< span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L271"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L271" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / 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,LPStream" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#atEof.e%2CLPStream" > < span class = "Identifier" > atEof< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > {.< span class = "Identifier" > base< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L126"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L126" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "close.e,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#close.e%2CLPStream" > < span class = "Identifier" > close< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / 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" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
2024-04-29 13:39:28 +00:00
2023-12-18 18:06:09 +00:00
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L297"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L297" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "closed.e,LPStream" class = "tohide" >
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#closed.e%2CLPStream" > < span class = "Identifier" > closed< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > bool< / span > {.< span class = "Identifier" > base< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L123"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L123" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "closeImpl.e,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#closeImpl.e%2CLPStream" > < span class = "Identifier" > closeImpl< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
2024-04-29 13:39:28 +00:00
2023-12-18 18:06:09 +00:00
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L284"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L284" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "initStream.e,LPStream" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#initStream.e%2CLPStream" > < span class = "Identifier" > initStream< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > {.< span class = "Identifier" > base< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Identifier" > TimeEffect< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L106"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L106" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "readOnce.e,LPStream,pointer,int" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#readOnce.e%2CLPStream%2Cpointer%2Cint" > < span class = "Identifier" > readOnce< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / 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" > InternalRaisesFuture< / span > < span class = "Other" > [< / span >
< span class = "Identifier" > int< / span > < span class = "Other" > ,< / span > < span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > base< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
2024-04-29 13:39:28 +00:00
2023-12-18 18:06:09 +00:00
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L133"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L133" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "write.e,LPStream,seq[byte]" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > method< / span > < a href = "#write.e%2CLPStream%2Cseq%5Bbyte%5D" > < span class = "Identifier" > write< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > s< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > ;< / span > < span class = "Identifier" > msg< / 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" > InternalRaisesFuture< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ,< / span >
< span class = "Other" > (< / span > < span class = "Identifier" > CancelledError< / span > < span class = "Other" > ,< / span > < a href = "lpstream.html#LPStreamError" > < span class = "Identifier" > LPStreamError< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > base< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > public< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / 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" > 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" > 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" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
2023-12-18 18:06:09 +00:00
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L251"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L251" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / 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,LPStream" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#formatItIMPL.t%2CLPStream" > < span class = "Identifier" > formatItIMPL< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > it< / span > < span class = "Other" > :< / span > < a href = "lpstream.html#LPStream" > < span class = "Identifier" > LPStream< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > auto< / span > < / pre > < / dt >
< dd >
< a
2024-04-29 13:39:28 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/stream/lpstream.nim#L104"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-04-29 13:39:28 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/stream/lpstream.nim#L104" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "19" >
< h1 > < a class = "toc-backref" href = "#19" > Exports< / a > < / h1 >
< dl class = "item" >
2024-05-14 05:12:10 +00:00
< a href = "../errors.html#toException,cstring" > < span class = "Identifier" > toException< / span > < / a > , < a href = "../errors.html#toException,string" > < span class = "Identifier" > toException< / span > < / a > , < a href = "../errors.html#checkFutures.m,seq[F],untyped" > < span class = "Identifier" > checkFutures< / span > < / a > , < a href = "../errors.html#LPError" > < span class = "Identifier" > LPError< / span > < / a >
2023-12-18 18:06:09 +00:00
< / dl > < / div >
< / div >
< / div >
< div class = "row" >
< div class = "twelve-columns footer" >
< span class = "nim-sprite" > < / span >
< br / >
2024-06-04 19:44:11 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2024-06-04 19:43:58 UTC< / small >
2023-12-18 18:06:09 +00:00
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
