Struct PyClassGetterGenerator 

pub struct PyClassGetterGenerator<ClassT: PyClass, FieldT, const OFFSET: usize, const IS_PY_T: bool, const IMPLEMENTS_INTOPYOBJECT_REF: bool, const IMPLEMENTS_INTOPYOBJECT: bool>(PhantomData<(ClassT, FieldT)>);

Type which uses specialization on impl blocks to determine how to read a field from a Rust pyclass as part of a #[pyo3(get)] annotation.

Tuple Fields

0: PhantomData<(ClassT, FieldT)>

Implementations

impl<ClassT: PyClass, FieldT, const OFFSET: usize, const IS_PY_T: bool, const IMPLEMENTS_INTOPYOBJECT_REF: bool, const IMPLEMENTS_INTOPYOBJECT: bool> PyClassGetterGenerator<ClassT, FieldT, OFFSET, IS_PY_T, IMPLEMENTS_INTOPYOBJECT_REF, IMPLEMENTS_INTOPYOBJECT>

pub const unsafe fn new() -> Self

Safety: constructing this type requires that there exists a value of type FieldT at the calculated offset within the type ClassT.

impl<ClassT: PyClass, U: PyTypeCheck, const OFFSET: usize, const IMPLEMENTS_INTOPYOBJECT_REF: bool, const IMPLEMENTS_INTOPYOBJECT: bool> PyClassGetterGenerator<ClassT, Py<U>, OFFSET, true, IMPLEMENTS_INTOPYOBJECT_REF, IMPLEMENTS_INTOPYOBJECT>

pub const fn generate( &self, name: &'static CStr, doc: Option<&'static CStr>, ) -> PyMethodDefType

Py<T> fields have a potential optimization to use Python’s “struct members” to read the field directly from the struct, rather than using a getter function.

This is the most efficient operation the Python interpreter could possibly do to read a field, but it’s only possible for us to allow this for frozen classes.

impl<ClassT, FieldT, const OFFSET: usize, const IMPLEMENTS_INTOPYOBJECT: bool> PyClassGetterGenerator<ClassT, FieldT, OFFSET, false, true, IMPLEMENTS_INTOPYOBJECT>

where ClassT: PyClass, for<'a, 'py> &'a FieldT: IntoPyObject<'py>,

Field is not Py<T>; try to use IntoPyObject for &T (preferred over ToPyObject) to avoid potentially expensive clones of containers like Vec

pub const fn generate( &self, name: &'static CStr, doc: Option<&'static CStr>, ) -> PyMethodDefType

impl<ClassT: PyClass, FieldT, const OFFSET: usize, const IMPLEMENTS_INTOPYOBJECT: bool> PyClassGetterGenerator<ClassT, FieldT, OFFSET, false, false, IMPLEMENTS_INTOPYOBJECT>

Base case attempts to use IntoPyObject + Clone

pub const fn generate( &self, name: &'static CStr, doc: Option<&'static CStr>, ) -> PyMethodDefType

where for<'py> FieldT: PyO3GetField<'py>,