Skip to content

Commit 8175f16

Browse files
committed
docs/glossary: Describe "stream" term.
1 parent 140acc9 commit 8175f16

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/reference/glossary.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,16 @@ Glossary
120120
from context, it's recommended to use full specification like one
121121
of the above.
122122

123+
stream
124+
Also known as a "file-like object". An object which provides sequential
125+
read-write access to the underlying data. A stream object implements
126+
a corresponding interface, which consists of methods like ``read()``,
127+
``write()``, ``readinto()``, ``seek()``, ``flush()``, ``close()``, etc.
128+
A stream is an important concept in MicroPython, many I/O objects
129+
implement the stream interface, and thus can be used consistently and
130+
interchangeably in different contexts. For more information on
131+
streams in MicroPython, see `uio` module.
132+
123133
upip
124134
(Literally, "micro pip"). A package manage for MicroPython, inspired
125135
by :term:`CPython`'s pip, but much smaller and with reduced functionality.

0 commit comments

Comments
 (0)