IQ.Lvbs/pycapnp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix up docs

Browse Source
This commit is contained in:
Jason Paryani
2013-08-18 22:43:40 -07:00
parent fdb427fb5c
commit 6c3041a9c6
2 changed files with 36 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/capnp.rst
View File

@@ -2,3 +2,34 @@
API Reference API Reference
=================== ===================
.. automodule:: capnp
.. currentmodule:: capnp
Functions
-------------
.. autofunction:: load
.. autofunction:: writeMessageToFd
.. autofunction:: writePackedMessageToFd
Readers
-------------
.. autoclass:: StreamFdMessageReader
:members:
:undoc-members:
:inherited-members:
.. autoclass:: PackedFdMessageReader
:members:
:undoc-members:
:inherited-members:
Writers
-------------
.. autoclass:: MallocMessageBuilder
:members:
:undoc-members:
:inherited-members:

10
docs/quickstart.rst
View File

@@ -8,7 +8,7 @@ This assumes you already have the capnp library installed. If you don't, please
In general, this library is a very light wrapping of the `Capnproto C++ library <http://kentonv.github.io/capnproto/cxx.html>`_. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured. In general, this library is a very light wrapping of the `Capnproto C++ library <http://kentonv.github.io/capnproto/cxx.html>`_. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured.
Load a Capnproto Schema Load a Capnproto Schema
------------- ------------------------
First you need to import the library:: First you need to import the library::
@@ -54,7 +54,7 @@ For future reference, here is the capnproto schema. Also available in the github
} }
Build a message Build a message
------------- ------------------
Message Builder Message Builder
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@@ -64,7 +64,7 @@ First you need to allocate a MessageBuilder for your message to go in. There is
message = capnp.MallocMessageBuilder() message = capnp.MallocMessageBuilder()
Initialize a New Capnproto Object Initialize a New Capnproto Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Now that you have a message buffer, you need to allocate an actual object that is from your schema. In this case, we will allocate an `AddressBook`:: Now that you have a message buffer, you need to allocate an actual object that is from your schema. In this case, we will allocate an `AddressBook`::
@@ -143,7 +143,7 @@ For now, the only way to serialize a message is to write it directly to a file d
Note the call to fileno(), since it expects a raw file descriptor. There is also `writeMessageToFd` instead of `writePackedMessageToFd`. Make sure your reader uses the same packing type. Note the call to fileno(), since it expects a raw file descriptor. There is also `writeMessageToFd` instead of `writePackedMessageToFd`. Make sure your reader uses the same packing type.
Read a message Read a message
------------- -----------------
Reading from a file Reading from a file
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
@@ -154,7 +154,7 @@ Much like before, you will have to de-serialize the message from a file descript
message = capnp.PackedFdMessageReader(f.fileno()) message = capnp.PackedFdMessageReader(f.fileno())
Initialize a New Capnproto Object Initialize a New Capnproto Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Just like when building, you have to actually specify which message you want to read out of buffer:: Just like when building, you have to actually specify which message you want to read out of buffer::