Struct pyo3::types::PyType

#[repr(transparent)]
pub struct PyType(_, _);

Represents a reference to a Python type object.

Methods

impl PyType

pub fn new<T: PyTypeInfo>() -> Py<PyType>

pub unsafe fn as_type_ptr(&self) -> *mut PyTypeObject

Retrieves the underlying FFI pointer associated with this Python object.

pub unsafe fn from_type_ptr(py: Python, p: *mut PyTypeObject) -> &PyType

Retrieves the PyType instance for the given FFI pointer. This increments the reference count on the type object. Undefined behavior if the pointer is NULL or invalid.

pub fn name(&self) -> Cow<str>

Gets the name of the PyType.

pub fn is_subclass<T>(&self) -> PyResult<bool> where
    T: PyTypeObject, 

Check whether self is subclass of type T like Python issubclass function

pub fn is_instance<T: AsPyPointer>(&self, obj: &T) -> PyResult<bool>

Trait Implementations

impl AsPyPointer for PyType

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyType

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyType

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for PyType

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> From<&'a PyType> for &'a PyAny

fn from(ob: &'a PyType) -> Self

Performs the conversion.

impl PartialEq<PyType> for PyType

fn eq(&self, o: &PyType) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyNativeType for PyType

fn py(&self) -> Python

impl PyObjectAlloc for PyType

unsafe fn alloc(_py: Python) -> *mut PyObject

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.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeInfo for PyType

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyTypeObject for PyType

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl ToPyObject for PyType

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

Converts self into a Python object.