python3.12/cpython/picklebufobject.h

0001 /* PickleBuffer object. This is built-in for ease of use from third-party
0002  * C extensions.
0003  */
0004
0005 #ifndef Py_PICKLEBUFOBJECT_H
0006 #define Py_PICKLEBUFOBJECT_H
0007 #ifdef __cplusplus
0008 extern "C" {
0009 #endif
0010
0011 #ifndef Py_LIMITED_API
0012
0013 PyAPI_DATA(PyTypeObject) PyPickleBuffer_Type;
0014
0015 #define PyPickleBuffer_Check(op) Py_IS_TYPE((op), &PyPickleBuffer_Type)
0016
0017 /* Create a PickleBuffer redirecting to the given buffer-enabled object */
0018 PyAPI_FUNC(PyObject *) PyPickleBuffer_FromObject(PyObject *);
0019 /* Get the PickleBuffer's underlying view to the original object
0020  * (NULL if released)
0021  */
0022 PyAPI_FUNC(const Py_buffer *) PyPickleBuffer_GetBuffer(PyObject *);
0023 /* Release the PickleBuffer.  Returns 0 on success, -1 on error. */
0024 PyAPI_FUNC(int) PyPickleBuffer_Release(PyObject *);
0025
0026 #endif /* !Py_LIMITED_API */
0027
0028 #ifdef __cplusplus
0029 }
0030 #endif
0031 #endif /* !Py_PICKLEBUFOBJECT_H */