msgpack-python/docs/api.rst

44 lines
748 B
ReStructuredText
Raw Permalink 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
2023-08-31 05:56:24 +02:00
``dump()`` is an alias for :func:`pack`
2013-02-24 18:06:36 +09:00
.. autofunction:: packb
2023-08-31 05:56:24 +02:00
``dumps()`` is an alias for :func:`packb`
2013-02-24 18:06:36 +09:00
.. autofunction:: unpack
2023-08-31 05:56:24 +02:00
``load()`` is an alias for :func:`unpack`
2013-02-24 18:06:36 +09:00
.. autofunction:: unpackb
2023-08-31 05:56:24 +02:00
``loads()`` is an alias for :func:`unpackb`
2013-02-24 18:06:36 +09:00
.. autoclass:: Packer
:members:
.. autoclass:: Unpacker
:members:
2013-10-21 01:47:54 +09:00
.. autoclass:: ExtType
2019-12-05 18:29:15 +09:00
.. autoclass:: Timestamp
:members:
:special-members: __init__
2013-02-24 18:06:36 +09:00
exceptions
----------
2013-02-24 18:06:36 +09:00
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: