diff options
author | Ezio Melotti <ezio.melotti@gmail.com> | 2009-09-20 07:10:39 (GMT) |
---|---|---|
committer | Ezio Melotti <ezio.melotti@gmail.com> | 2009-09-20 07:10:39 (GMT) |
commit | 4b017bbac0dd4e0a7e3c4424157c278dc4f8fa72 (patch) | |
tree | bb2adbdaa378529d4957071f44ef6da7d36be124 /Doc | |
parent | 14a2e2f614c068a63651a6bb5c9821e5d8f8bac0 (diff) | |
download | cpython-4b017bbac0dd4e0a7e3c4424157c278dc4f8fa72.zip cpython-4b017bbac0dd4e0a7e3c4424157c278dc4f8fa72.tar.gz cpython-4b017bbac0dd4e0a7e3c4424157c278dc4f8fa72.tar.bz2 |
#6881 - fixed wrong return type; improved the formatting
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/bytearray.rst | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/Doc/c-api/bytearray.rst b/Doc/c-api/bytearray.rst index af5b5e3..a605091 100644 --- a/Doc/c-api/bytearray.rst +++ b/Doc/c-api/bytearray.rst @@ -20,6 +20,8 @@ Byte Array Objects This instance of :ctype:`PyTypeObject` represents the Python bytearray type; it is the same object as ``bytearray`` in the Python layer. +Type check macros +^^^^^^^^^^^^^^^^^ .. cfunction:: int PyByteArray_Check(PyObject *o) @@ -33,6 +35,9 @@ Byte Array Objects subtype of the bytearray type. +Direct API functions +^^^^^^^^^^^^^^^^^^^^ + .. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o) Return a new bytearray object from any object, *o*, that implements the @@ -47,14 +52,14 @@ Byte Array Objects failure, *NULL* is returned. -.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray) +.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b) - Return the size of *bytearray* after checking for a *NULL* pointer. + Concat bytearrays *a* and *b* and return a new bytearray with the result. -.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray) +.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray) - Macro version of :cfunc:`PyByteArray_Size` that doesn't do pointer checking. + Return the size of *bytearray* after checking for a *NULL* pointer. .. cfunction:: char* PyByteArray_AsString(PyObject *bytearray) @@ -63,16 +68,20 @@ Byte Array Objects *NULL* pointer. -.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray) +.. cfunction:: int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len) - Macro version of :cfunc:`PyByteArray_AsString` that doesn't check pointers. + Resize the internal buffer of *bytearray* to *len*. +Macros +^^^^^^ -.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b) +These macros trade safety for speed and they don't check pointers. - Concat bytearrays *a* and *b* and return a new bytearray with the result. +.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray) + Macro version of :cfunc:`PyByteArray_AsString`. -.. cfunction:: PyObject* PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len) - Resize the internal buffer of *bytearray* to *len*. +.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray) + + Macro version of :cfunc:`PyByteArray_Size`. |