diff options
Diffstat (limited to 'docs/lib/bps.stream.rst')
| -rw-r--r-- | docs/lib/bps.stream.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/lib/bps.stream.rst b/docs/lib/bps.stream.rst new file mode 100644 index 0000000..9955abd --- /dev/null +++ b/docs/lib/bps.stream.rst @@ -0,0 +1,24 @@ +=============================================== +:mod:`bps.stream` -- Stream & Buffer Utilities +=============================================== + +.. module:: bps.stream + :synopsis: stream (file, StringIO) helpers + +This module contain various stream & buffer related utilities. + +Non-Blocking Reads +================== + +.. autofunction:: nb_read +.. autofunction:: nb_readline_iter +.. autoclass:: nb_readline_list + +Other Functions +=============== +.. autofunction:: get_stream_size + +.. + not listing this one till it's heuristic or use-case is better defined: + + .. autofunction:: get_input_type |