Skip to main content

pyo3_ffi/cpython/
listobject.rs

1#[cfg(Py_GIL_DISABLED)]
2use crate::cpython::pyatomic::_Py_atomic_load_ssize_relaxed;
3use crate::object::*;
4#[cfg(not(PyPy))]
5use crate::pyport::Py_ssize_t;
6#[cfg(not(PyPy))]
7use crate::PyList_Check;
8
9#[cfg(not(PyPy))]
10#[repr(C)]
11pub struct PyListObject {
12    pub ob_base: PyVarObject,
13    pub ob_item: *mut *mut PyObject,
14    pub allocated: Py_ssize_t,
15}
16
17#[cfg(PyPy)]
18pub struct PyListObject {
19    pub ob_base: PyObject,
20}
21
22#[inline]
23#[cfg(not(PyPy))]
24pub(crate) unsafe fn _PyList_CAST(op: *mut PyObject) -> *mut PyListObject {
25    debug_assert_eq!(PyList_Check(op), 1);
26    op.cast()
27}
28
29#[inline]
30#[cfg(not(PyPy))]
31pub unsafe fn PyList_GET_SIZE(op: *mut PyObject) -> Py_ssize_t {
32    let list = _PyList_CAST(op);
33    #[cfg(Py_GIL_DISABLED)]
34    {
35        _Py_atomic_load_ssize_relaxed(&raw const (*_PyVarObject_CAST(list.cast())).ob_size)
36    }
37    #[cfg(not(Py_GIL_DISABLED))]
38    {
39        Py_SIZE(list.cast())
40    }
41}
42
43/// Macro, trading safety for speed
44#[inline]
45#[cfg(not(any(PyPy, GraalPy)))]
46pub unsafe fn PyList_GET_ITEM(op: *mut PyObject, i: Py_ssize_t) -> *mut PyObject {
47    *(*_PyList_CAST(op)).ob_item.offset(i)
48}
49
50/// Macro, *only* to be used to fill in brand new lists
51#[inline]
52#[cfg(not(any(PyPy, GraalPy)))]
53pub unsafe fn PyList_SET_ITEM(op: *mut PyObject, i: Py_ssize_t, v: *mut PyObject) {
54    *(*_PyList_CAST(op)).ob_item.offset(i) = v;
55}
56
57// skipped _PyList_Extend
58// skipped _PyList_DebugMallocStats
⚠️ Internal Docs ⚠️ Not Public API 👉 Official Docs Here