← Back to branch summary

~ubuntu-branches/debian/sid/pyrlp/sid

« back to all changes in this revision

Viewing changes to docs/api.rst

  • Committer: Package Import Robot
  • Author(s): Ben Finney
  • Date: 2017-07-15 05:25:42 UTC
  • Revision ID: package-import@ubuntu.com-20170715052542-a20zzsypt1qfecq1
Tags: upstream-0.5.1
Import upstream version 0.5.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/api.rst
 
1
.. _api-reference:
 
2
 
 
3
API Reference
 
4
=============
 
5
 
 
6
Functions
 
7
---------
 
8
 
 
9
.. autofunction:: rlp.encode
 
10
 
 
11
.. autofunction:: rlp.decode
 
12
 
 
13
.. autofunction:: rlp.decode_lazy
 
14
 
 
15
    .. autoclass:: rlp.LazyList
 
16
 
 
17
.. autofunction:: rlp.infer_sedes
 
18
 
 
19
 
 
20
Sedes Objects
 
21
-------------
 
22
 
 
23
.. data:: rlp.sedes.raw
 
24
 
 
25
   A sedes object that does nothing. Thus, it can serialize everything that can
 
26
   be directly encoded in RLP (nested lists of strings). This sedes can be used
 
27
   as a placeholder when deserializing larger structures.
 
28
 
 
29
.. autoclass:: rlp.sedes.Binary
 
30
 
 
31
   .. automethod:: rlp.sedes.Binary.fixed_length
 
32
 
 
33
.. data:: rlp.sedes.binary
 
34
 
 
35
    A sedes object for binary data of arbitrary length (an instance of
 
36
    :class:`rlp.sedes.Binary` with default arguments).
 
37
 
 
38
.. autoclass:: rlp.sedes.BigEndianInt
 
39
 
 
40
.. data:: rlp.sedes.big_endian_int
 
41
 
 
42
    A sedes object for integers encoded in big endian without any leading zeros
 
43
    (an instance of :class:`rlp.sedes.BigEndianInt` with default arguments).
 
44
 
 
45
.. autoclass:: rlp.sedes.List
 
46
 
 
47
.. autoclass:: rlp.sedes.CountableList
 
48
 
 
49
.. autoclass:: rlp.Serializable
 
50
    :members:
 
51
 
 
52
Exceptions
 
53
----------
 
54
 
 
55
.. autoexception:: rlp.RLPException
 
56
 
 
57
.. autoexception:: rlp.EncodingError
 
58
 
 
59
.. autoexception:: rlp.DecodingError
 
60
 
 
61
.. autoexception:: rlp.SerializationError
 
62
 
 
63
.. autoexception:: rlp.DeserializationError