Struct pyo3::pyclass::PyClassShell

#[repr(C)]
pub struct PyClassShell<T: PyClass> { /* fields omitted */ }

PyClassShell represents the concrete layout of T: PyClass when it is converted to a Python class.

You can use it to test your #[pyclass] correctly works.

#[pyclass]
struct Book {
    #[pyo3(get)]
    name: &'static str,
    author: &'static str,
}
let gil = Python::acquire_gil();
let py = gil.python();
let book = Book {
    name: "The Man in the High Castle",
    author: "Philip Kindred Dick",
};
let book_shell = PyClassShell::new_ref(py, book).unwrap();
py_run!(py, book_shell, "assert book_shell.name[-6:] == 'Castle'");

Methods

impl<T: PyClass> PyClassShell<T>

pub fn new_ref(
    py: Python,
    value: impl Into<PyClassInitializer<T>>
) -> PyResult<&Self> where
    <T::BaseType as PyTypeInfo>::ConcreteLayout: PyObjectSizedLayout<T::BaseType>, 

Make new PyClassShell on the Python heap and returns the reference of it.

pub fn new_mut(
    py: Python,
    value: impl Into<PyClassInitializer<T>>
) -> PyResult<&mut Self> where
    <T::BaseType as PyTypeInfo>::ConcreteLayout: PyObjectSizedLayout<T::BaseType>, 

Make new PyClassShell on the Python heap and returns the mutable reference of it.

pub fn get_super(&self) -> &<T::BaseType as PyTypeInfo>::ConcreteLayout

Get the reference of base object.

pub fn get_super_mut(
    &mut self
) -> &mut <T::BaseType as PyTypeInfo>::ConcreteLayout

Get the mutable reference of base object.

Trait Implementations

impl<T: PyClass> AsPyPointer for PyClassShell<T>

fn as_ptr(&self) -> *mut PyObject

Retrieves the underlying FFI pointer (as a borrowed pointer).

impl<T: PyClass> Deref for PyClassShell<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: PyClass> DerefMut for PyClassShell<T>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, '_, T> From<&'_ PyClassShell<T>> for Py<T> where
    T: PyClass, 

fn from(shell: &PyClassShell<T>) -> Self

Performs the conversion.

impl<'a, '_, T> From<&'_ mut PyClassShell<T>> for Py<T> where
    T: PyClass, 

fn from(shell: &mut PyClassShell<T>) -> Self

Performs the conversion.

impl<'p, T> FromPyPointer<'p> for &'p PyClassShell<T> where
    T: PyClass, 

unsafe fn from_owned_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_borrowed_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_owned_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

unsafe fn from_borrowed_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

impl<'p, T> FromPyPointer<'p> for &'p mut PyClassShell<T> where
    T: PyClass, 

unsafe fn from_owned_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_borrowed_ptr_or_opt(
    py: Python<'p>,
    ptr: *mut PyObject
) -> Option<Self>

unsafe fn from_owned_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_owned_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

unsafe fn from_borrowed_ptr_or_panic(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> Self

unsafe fn from_borrowed_ptr_or_err(
    py: Python<'p>,
    ptr: *mut PyObject
) -> PyResult<Self>

impl<T: PyClass> PyObjectLayout<T> for PyClassShell<T>

const IS_NATIVE_TYPE: bool

fn get_super_or(
    &mut self
) -> Option<&mut <T::BaseType as PyTypeInfo>::ConcreteLayout>

unsafe fn internal_ref_cast(obj: &PyAny) -> &T

unsafe fn internal_mut_cast(obj: &PyAny) -> &mut T

unsafe fn py_drop(&mut self, py: Python)

unsafe fn py_init(&mut self, value: T)

impl<T: PyClass> PyObjectSizedLayout<T> for PyClassShell<T>

impl<'_, T: PyClass> ToPyObject for &'_ PyClassShell<T>

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl<'_, T: PyClass> ToPyObject for &'_ mut PyClassShell<T>

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.