summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
authordef <dennis@felsin9.de>2015-04-26 17:06:41 +0200
committerdef <dennis@felsin9.de>2015-04-26 17:06:41 +0200
commit1b7cf0e3f364fa768eb17e3a7714fd30effd43db (patch)
tree7544bc7dfdd863685474b89c442674d93623ddab /lib
parent84315c6a9ce383620a49620cda98ad1158f92010 (diff)
downloadNim-1b7cf0e3f364fa768eb17e3a7714fd30effd43db.tar.gz
Add warning about recvLineInto being bound to change
Diffstat (limited to 'lib')
-rw-r--r--lib/pure/asyncnet.nim3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/pure/asyncnet.nim b/lib/pure/asyncnet.nim
index a79f30ab3..aadbde824 100644
--- a/lib/pure/asyncnet.nim
+++ b/lib/pure/asyncnet.nim
@@ -325,6 +325,9 @@ proc recvLineInto*(socket: AsyncSocket, resString: ptr string,
   ##
   ## **Warning**: ``recvLineInto`` on unbuffered sockets assumes that the
   ## protocol uses ``\r\L`` to delimit a new line.
+  ##
+  ## **Warning**: ``recvLineInto`` currently uses a raw pointer to a string for
+  ## performance reasons. This will likely change soon to use FutureVars.
   assert SocketFlag.Peek notin flags ## TODO:
   result = newFuture[void]("asyncnet.recvLineInto")