summaryrefslogtreecommitdiff
path: root/docs/api.rst
blob: 841c1346bedd7a2551536ca596271736bf8d3290 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
API reference
=============

.. 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:

.. autoclass:: ExtType

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: