Struct PyType

pub struct PyType(/* private fields */);

Represents a reference to a Python type object.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyType> or Bound<'py, PyType>.

For APIs available on type objects, see the PyTypeMethods trait which is implemented for Bound<'py, PyType>.

Implementations

impl PyType

pub fn new_bound<T: PyTypeInfo>(py: Python<'_>) -> Bound<'_, PyType>

Creates a new type object.

pub unsafe fn from_borrowed_type_ptr( py: Python<'_>, p: *mut PyTypeObject, ) -> Bound<'_, PyType>

Converts the given FFI pointer into Bound<PyType>, to use in safe code.

The function creates a new reference from the given pointer, and returns it as a Bound<PyType>.

Safety

• The pointer must be a valid non-null reference to a PyTypeObject

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

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for PyType

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyType

const NAME: &'static str = "PyType"

Class name.

const MODULE: Option<&'static str> = _

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for PyType