From 80c68206f7ed68d64417680120f0898e32ade562 Mon Sep 17 00:00:00 2001 From: Dmitriy Ryajov Date: Wed, 4 Sep 2019 00:40:53 -0600 Subject: [PATCH] documentation --- libp2p/stream/bufferstream.nim | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/libp2p/stream/bufferstream.nim b/libp2p/stream/bufferstream.nim index 24ca82850..891e88fd1 100644 --- a/libp2p/stream/bufferstream.nim +++ b/libp2p/stream/bufferstream.nim @@ -26,7 +26,7 @@ ## and are suspended when not enough data available. This ## allows preserving backpressure while maintaining full ## asynchrony. Both writting to the internal buffer with -## ``pushTo`` as well as reading with ``read`` and ``readOnce``, +## ``pushTo`` as well as reading with ``read*` methods, ## will suspend until either the amount of elements in the ## buffer goes below ``maxSize`` or more data becomes available. @@ -165,9 +165,9 @@ method readLine*(s: BufferStream, break inc(index) -method readOnce*(s: BufferStream, - pbytes: pointer, - nbytes: int): +method readOnce*(s: BufferStream, + pbytes: pointer, + nbytes: int): Future[int] {.async, gcsafe.} = ## Perform one read operation on read-only stream ``rstream``. ##