Add PyObject_CheckReadBuffer(), which returns true if its argument

supports the single-segment readable buffer interface.

Add documentation for this and other PyObject_XXXBuffer() calls.

1 files changed, 39 insertions, 0 deletions

diff --git a/Doc/api/abstract.tex b/Doc/api/abstract.tex
index 3078e904b5..c6a19c23e2 100644
--- a/Doc/api/abstract.tex
+++ b/Doc/api/abstract.tex
@@ -867,4 +867,43 @@ if (PyErr_Occurred()) {
 else {
     /* continue doing useful work */
 }
+
+\section{Buffer Protocol \label{buffer}}
+
+\begin{cfuncdesc}{int}{PyObject_AsCharBuffer}{PyObject *obj,
+					      const char **buffer,
+					      int *buffer_len}
+  Returns a pointer to a read-only memory location useable as character-
+  based input.  The \var{obj} argument must support the single-segment
+  character buffer interface.  On success, returns \code{1}, sets
+  \var{buffer} to the memory location and \var{buffer} to the buffer
+  length.  Returns \code{0} and sets a \exception{TypeError} on error.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{int}{PyObject_AsReadBuffer}{PyObject *obj,
+					      const char **buffer,
+					      int *buffer_len}
+  Returns a pointer to a read-only memory location containing
+  arbitrary data.  The \var{obj} argument must support the
+  single-segment readable buffer interface.  On success, returns
+  \code{1}, sets \var{buffer} to the memory location and \var{buffer}
+  to the buffer length.  Returns \code{0} and sets a
+  \exception{TypeError} on error.
+\end{cfuncdesc}
+
+\begin{cfuncdesc}{int}{PyObject_CheckReadBuffer}{PyObject *o}
+  Returns \code{1} if \var{o} supports the single-segment readable
+  buffer interface.  Otherwise returns \code{0}.
+\enc{cfuncdesc}
+
+\begin{cfuncdesc}{int}{PyObject_AsWriteBuffer}{PyObject *obj,
+	 				       const char **buffer,
+ 					       int *buffer_len}
+  Returns a pointer to a writeable memory location.  The \var{obj}
+  argument must support the single-segment, character buffer
+  interface.  On success, returns \code{1}, sets \var{buffer} to the
+  memory location and \var{buffer} to the buffer length.  Returns
+  \code{0} and sets a \exception{TypeError} on error.
+\end{cfuncdesc}
+
 \end{verbatim}