msgpack-python/docs/api.rst

40 lines
674 B
ReStructuredText
Raw Normal View History

2013-02-24 18:06:36 +09:00
API reference
2013-02-25 14:29:49 +09:00
=============
2013-02-24 18:06:36 +09:00
.. module:: msgpack
.. autofunction:: pack
:func:`dump` is alias for :func:`pack`
.. autofunction:: packb
:func:`dumps` is alias for :func:`packb`
.. autofunction:: unpack
:func:`load` is alias for :func:`unpack`
.. autofunction:: unpackb
:func:`loads` is alias for :func:`unpackb`
.. autoclass:: Packer
:members:
.. autoclass:: Unpacker
:members:
2013-10-21 01:47:54 +09:00
.. autoclass:: ExtType
2013-02-24 18:06:36 +09:00
exceptions
-----------
These exceptions are accessible via `msgpack` package.
(For example, `msgpack.OutOfData` is shortcut for `msgpack.exceptions.OutOfData`)
.. automodule:: msgpack.exceptions
:members:
:undoc-members:
:show-inheritance: