summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien George <damien@micropython.org>2021-07-22 17:13:10 +1000
committerDamien George <damien@micropython.org>2021-07-22 22:39:04 +1000
commit7f69246895ed4df78909c3558b91624ad3b3986c (patch)
treef54636084bf12b187f5019bb1a64d827e2e0a85b
parenta5ac3d5645e99a897f3213149587a43b62779c35 (diff)
docs/library/uasyncio.rst: Document stream readexactly() method.
Signed-off-by: Damien George <damien@micropython.org>
-rw-r--r--docs/library/uasyncio.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/uasyncio.rst b/docs/library/uasyncio.rst
index 0be328829..11b9c6aee 100644
--- a/docs/library/uasyncio.rst
+++ b/docs/library/uasyncio.rst
@@ -248,6 +248,14 @@ TCP stream connections
This is a coroutine, and a MicroPython extension.
+.. method:: Stream.readexactly(n)
+
+ Read exactly *n* bytes and return them as a bytes object.
+
+ Raises an ``EOFError`` exception if the stream ends before reading *n* bytes.
+
+ This is a coroutine.
+
.. method:: Stream.readline()
Read a line and return it.