6.6 Buffer Protocol
Description: Buffer Protocol
Keywords: api

#
6.6 Buffer Protocol

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 obj argument must support the single-segment character buffer interface. On success, returns `0`, sets buffer to the memory location and buffer_len to the buffer length. Returns `-1` and sets a `TypeError` on error. New in version 1.6.

int `PyObject_AsReadBuffer`( | PyObject *obj, const char **buffer, int *buffer_len)

  Returns a pointer to a read-only memory location containing arbitrary data. The obj argument must support the single-segment readable buffer interface. On success, returns `0`, sets buffer to the memory location and buffer_len to the buffer length. Returns `-1` and sets a `TypeError` on error. New in version 1.6.

int `PyObject_CheckReadBuffer`( | PyObject *o)

  Returns `1` if o supports the single-segment readable buffer interface. Otherwise returns `0`. New in version 2.2.

int `PyObject_AsWriteBuffer`( | PyObject *obj, char **buffer, int *buffer_len)

  Returns a pointer to a writeable memory location. The obj argument must support the single-segment, character buffer interface. On success, returns `0`, sets buffer to the memory location and buffer_len to the buffer length. Returns `-1` and sets a `TypeError` on error. New in version 1.6.