Trait cpython::py_class::BaseObject

pub trait BaseObject: PythonObject {
    type InitType;
    pub fn size() -> usize;
    pub unsafe fn alloc(
        py: Python<'_>, 
        ty: &PyType, 
        init_val: Self::InitType
    ) -> PyResult<PyObject>;
    pub unsafe fn dealloc(py: Python<'_>, obj: *mut PyObject);
}

A PythonObject that is usable as a base type with the py_class!() macro.

Associated Types

type InitType

Loading content...

Required methods

pub fn size() -> usize

Gets the size of the object, in bytes.

pub unsafe fn alloc(
    py: Python<'_>,
    ty: &PyType,
    init_val: Self::InitType
) -> PyResult<PyObject>

Allocates a new object (usually by calling ty->tp_alloc), and initializes it using init_val. ty must be derived from the Self type, and the resulting object must be of type ty.

pub unsafe fn dealloc(py: Python<'_>, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

Loading content...

Implementors

impl BaseObject for PyObject

pub fn size() -> usize

type InitType = ()

pub unsafe fn alloc(
    py: Python<'_>,
    ty: &PyType,
    _init_val: ()
) -> PyResult<PyObject>

pub unsafe fn dealloc(_py: Python<'_>, obj: *mut PyObject)

Loading content...