API
===

.. autosummary::
   :toctree: generated

:mod:`streamerate.streams` -- the main module with streams functionalities
===================================================

.. module:: streamerate.streams

.. autoclass:: streamerate.streams.stream
   :members:
   :inherited-members:

   .. automethod:: __len__
   .. automethod:: __contains__

.. autoclass:: streamerate.streams.AbstractSynchronizedBufferedStream
   :members:
   :inherited-members:

.. autoclass:: streamerate.streams.buffered_stream
   :members:
   :inherited-members:

.. autoclass:: streamerate.streams.sset
   :members:
   :inherited-members:

.. autoclass:: streamerate.streams.slist
   :members:
   :inherited-members:

.. autoclass:: streamerate.streams.sdict
    :members:
    :inherited-members:

# add a function smap()
.. autofunction:: streamerate.streams.smap

.. autofunction:: streamerate.streams.sfilter