Struct pyo3::pyclass::create_type_object::PyTypeBuilder

struct PyTypeBuilder {

    slots: Vec<PyType_Slot>,
    method_defs: Vec<PyMethodDef>,
    getset_builders: HashMap<&'static str, GetSetDefBuilder>,
    cleanup: Vec<Box<dyn Fn(&PyTypeBuilder, *mut PyTypeObject)>>,
    tp_base: *mut PyTypeObject,
    tp_dealloc: destructor,
    tp_dealloc_with_gc: destructor,
    is_mapping: bool,
    is_sequence: bool,
    has_new: bool,
    has_dealloc: bool,
    has_getitem: bool,
    has_setitem: bool,
    has_traverse: bool,
    has_clear: bool,
    has_dict: bool,
    class_flags: c_ulong,
    buffer_procs: PyBufferProcs,
}

Fields

slots: Vec<PyType_Slot>

method_defs: Vec<PyMethodDef>

getset_builders: HashMap<&'static str, GetSetDefBuilder>

cleanup: Vec<Box<dyn Fn(&PyTypeBuilder, *mut PyTypeObject)>>

Used to patch the type objects for the things there’s no PyType_FromSpec API for… there’s no reason this should work, except for that it does and we have tests.

tp_base: *mut PyTypeObject

tp_dealloc: destructor

tp_dealloc_with_gc: destructor

is_mapping: bool

is_sequence: bool

has_new: bool

has_dealloc: bool

has_getitem: bool

has_setitem: bool

has_traverse: bool

has_clear: bool

has_dict: bool

class_flags: c_ulong

buffer_procs: PyBufferProcs

Available on non-Py_3_9 and non-Py_LIMITED_API only.

Implementations

impl PyTypeBuilder

unsafe fn push_slot<T>(&mut self, slot: c_int, pfunc: *mut T)

Safety

The given pointer must be of the correct type for the given slot

unsafe fn push_raw_vec_slot<T>(&mut self, slot: c_int, data: Vec<T>)

Safety

It is the caller’s responsibility that data is of the correct type for the given slot.

fn pymethod_def(&mut self, def: &PyMethodDefType)

fn finalize_methods_and_properties( &mut self ) -> PyResult<Vec<GetSetDefDestructor>>

fn set_is_basetype(self, is_basetype: bool) -> Self

unsafe fn class_items(self, iter: PyClassItemsIter) -> Self

Safety

All slots in the PyClassItemsIter should be correct

fn type_doc(self, type_doc: &'static CStr) -> Self

fn offsets( self, dict_offset: Option<Py_ssize_t>, weaklist_offset: Option<Py_ssize_t> ) -> Self

fn build( self, py: Python<'_>, name: &'static str, module_name: Option<&'static str>, basicsize: usize ) -> PyResult<PyClassTypeObject>