Trait pyo3::type_object::PyTypeInfo

pub unsafe trait PyTypeInfo: Sized {
    type AsRefTarget: PyNativeType;

    const NAME: &'static str;
    const MODULE: Option<&'static str>;

    // Required method
    fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject;

    // Provided methods
    fn type_object(py: Python<'_>) -> &PyType { ... }
    fn is_type_of(object: &PyAny) -> bool { ... }
    fn is_exact_type_of(object: &PyAny) -> bool { ... }
}

Python type information. All Python native types (e.g., PyDict) and #[pyclass] structs implement this trait.

This trait is marked unsafe because:

• specifying the incorrect layout can lead to memory errors
• the return value of type_object must always point to the same PyTypeObject instance

It is safely implemented by the pyclass macro.

Safety

Implementations must provide an implementation for type_object_raw which infallibly produces a non-null pointer to the corresponding Python type object.

Required Associated Types

type AsRefTarget: PyNativeType

Utility type to make Py::as_ref work.

Required Associated Constants

const NAME: &'static str

Class name.

const MODULE: Option<&'static str>

Module name, if any.

Required Methods

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

Returns the PyTypeObject instance for this type.

Provided Methods

fn type_object(py: Python<'_>) -> &PyType

Returns the safe abstraction over the type object.

fn is_type_of(object: &PyAny) -> bool

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

fn is_exact_type_of(object: &PyAny) -> bool

Checks if object is an instance of this type.

Object Safety

This trait is not object safe.

Implementors

impl PyTypeInfo for CancelledError

type AsRefTarget = CancelledError

const NAME: &'static str = "CancelledError"

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

impl PyTypeInfo for IncompleteReadError

type AsRefTarget = IncompleteReadError

const NAME: &'static str = "IncompleteReadError"

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

impl PyTypeInfo for InvalidStateError

type AsRefTarget = InvalidStateError

const NAME: &'static str = "InvalidStateError"

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

impl PyTypeInfo for LimitOverrunError

type AsRefTarget = LimitOverrunError

const NAME: &'static str = "LimitOverrunError"

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

impl PyTypeInfo for QueueEmpty

type AsRefTarget = QueueEmpty

const NAME: &'static str = "QueueEmpty"

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

impl PyTypeInfo for QueueFull

type AsRefTarget = QueueFull

const NAME: &'static str = "QueueFull"

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

impl PyTypeInfo for TimeoutError

type AsRefTarget = TimeoutError

const NAME: &'static str = "TimeoutError"

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

impl PyTypeInfo for gaierror

type AsRefTarget = gaierror

const NAME: &'static str = "gaierror"

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

impl PyTypeInfo for herror

type AsRefTarget = herror

const NAME: &'static str = "herror"

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

impl PyTypeInfo for timeout

type AsRefTarget = timeout

const NAME: &'static str = "timeout"

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

impl PyTypeInfo for PyArithmeticError

type AsRefTarget = PyArithmeticError

const NAME: &'static str = "PyArithmeticError"

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

impl PyTypeInfo for PyAssertionError

type AsRefTarget = PyAssertionError

const NAME: &'static str = "PyAssertionError"

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

impl PyTypeInfo for PyAttributeError

type AsRefTarget = PyAttributeError

const NAME: &'static str = "PyAttributeError"

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

impl PyTypeInfo for PyBaseException

type AsRefTarget = PyBaseException

const NAME: &'static str = "PyBaseException"

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

impl PyTypeInfo for PyBlockingIOError

type AsRefTarget = PyBlockingIOError

const NAME: &'static str = "PyBlockingIOError"

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

impl PyTypeInfo for PyBrokenPipeError

type AsRefTarget = PyBrokenPipeError

const NAME: &'static str = "PyBrokenPipeError"

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

impl PyTypeInfo for PyBufferError

type AsRefTarget = PyBufferError

const NAME: &'static str = "PyBufferError"

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

impl PyTypeInfo for PyBytesWarning

type AsRefTarget = PyBytesWarning

const NAME: &'static str = "PyBytesWarning"

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

impl PyTypeInfo for PyChildProcessError

type AsRefTarget = PyChildProcessError

const NAME: &'static str = "PyChildProcessError"

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

impl PyTypeInfo for PyConnectionAbortedError

type AsRefTarget = PyConnectionAbortedError

const NAME: &'static str = "PyConnectionAbortedError"

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

impl PyTypeInfo for PyConnectionError

type AsRefTarget = PyConnectionError

const NAME: &'static str = "PyConnectionError"

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

impl PyTypeInfo for PyConnectionRefusedError

type AsRefTarget = PyConnectionRefusedError

const NAME: &'static str = "PyConnectionRefusedError"

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

impl PyTypeInfo for PyConnectionResetError

type AsRefTarget = PyConnectionResetError

const NAME: &'static str = "PyConnectionResetError"

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

impl PyTypeInfo for PyDeprecationWarning

type AsRefTarget = PyDeprecationWarning

const NAME: &'static str = "PyDeprecationWarning"

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

impl PyTypeInfo for PyEOFError

type AsRefTarget = PyEOFError

const NAME: &'static str = "PyEOFError"

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

impl PyTypeInfo for PyEncodingWarning

type AsRefTarget = PyEncodingWarning

const NAME: &'static str = "PyEncodingWarning"

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

impl PyTypeInfo for PyEnvironmentError

type AsRefTarget = PyEnvironmentError

const NAME: &'static str = "PyEnvironmentError"

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

impl PyTypeInfo for PyException

type AsRefTarget = PyException

const NAME: &'static str = "PyException"

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

impl PyTypeInfo for PyFileExistsError

type AsRefTarget = PyFileExistsError

const NAME: &'static str = "PyFileExistsError"

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

impl PyTypeInfo for PyFileNotFoundError

type AsRefTarget = PyFileNotFoundError

const NAME: &'static str = "PyFileNotFoundError"

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

impl PyTypeInfo for PyFloatingPointError

type AsRefTarget = PyFloatingPointError

const NAME: &'static str = "PyFloatingPointError"

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

impl PyTypeInfo for PyFutureWarning

type AsRefTarget = PyFutureWarning

const NAME: &'static str = "PyFutureWarning"

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

impl PyTypeInfo for PyGeneratorExit

type AsRefTarget = PyGeneratorExit

const NAME: &'static str = "PyGeneratorExit"

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

impl PyTypeInfo for PyIOError

type AsRefTarget = PyIOError

const NAME: &'static str = "PyIOError"

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

impl PyTypeInfo for PyImportError

type AsRefTarget = PyImportError

const NAME: &'static str = "PyImportError"

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

impl PyTypeInfo for PyImportWarning

type AsRefTarget = PyImportWarning

const NAME: &'static str = "PyImportWarning"

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

impl PyTypeInfo for PyIndexError

type AsRefTarget = PyIndexError

const NAME: &'static str = "PyIndexError"

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

impl PyTypeInfo for PyInterruptedError

type AsRefTarget = PyInterruptedError

const NAME: &'static str = "PyInterruptedError"

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

impl PyTypeInfo for PyIsADirectoryError

type AsRefTarget = PyIsADirectoryError

const NAME: &'static str = "PyIsADirectoryError"

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

impl PyTypeInfo for PyKeyError

type AsRefTarget = PyKeyError

const NAME: &'static str = "PyKeyError"

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

impl PyTypeInfo for PyKeyboardInterrupt

type AsRefTarget = PyKeyboardInterrupt

const NAME: &'static str = "PyKeyboardInterrupt"

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

impl PyTypeInfo for PyLookupError

type AsRefTarget = PyLookupError

const NAME: &'static str = "PyLookupError"

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

impl PyTypeInfo for PyMemoryError

type AsRefTarget = PyMemoryError

const NAME: &'static str = "PyMemoryError"

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

impl PyTypeInfo for PyModuleNotFoundError

type AsRefTarget = PyModuleNotFoundError

const NAME: &'static str = "PyModuleNotFoundError"

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

impl PyTypeInfo for PyNameError

type AsRefTarget = PyNameError

const NAME: &'static str = "PyNameError"

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

impl PyTypeInfo for PyNotADirectoryError

type AsRefTarget = PyNotADirectoryError

const NAME: &'static str = "PyNotADirectoryError"

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

impl PyTypeInfo for PyNotImplementedError

type AsRefTarget = PyNotImplementedError

const NAME: &'static str = "PyNotImplementedError"

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

impl PyTypeInfo for PyOSError

type AsRefTarget = PyOSError

const NAME: &'static str = "PyOSError"

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

impl PyTypeInfo for PyOverflowError

type AsRefTarget = PyOverflowError

const NAME: &'static str = "PyOverflowError"

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

impl PyTypeInfo for PyPendingDeprecationWarning

type AsRefTarget = PyPendingDeprecationWarning

const NAME: &'static str = "PyPendingDeprecationWarning"

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

impl PyTypeInfo for PyPermissionError

type AsRefTarget = PyPermissionError

const NAME: &'static str = "PyPermissionError"

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

impl PyTypeInfo for PyProcessLookupError

type AsRefTarget = PyProcessLookupError

const NAME: &'static str = "PyProcessLookupError"

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

impl PyTypeInfo for PyRecursionError

type AsRefTarget = PyRecursionError

const NAME: &'static str = "PyRecursionError"

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

impl PyTypeInfo for PyReferenceError

type AsRefTarget = PyReferenceError

const NAME: &'static str = "PyReferenceError"

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

impl PyTypeInfo for PyResourceWarning

type AsRefTarget = PyResourceWarning

const NAME: &'static str = "PyResourceWarning"

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

impl PyTypeInfo for PyRuntimeError

type AsRefTarget = PyRuntimeError

const NAME: &'static str = "PyRuntimeError"

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

impl PyTypeInfo for PyRuntimeWarning

type AsRefTarget = PyRuntimeWarning

const NAME: &'static str = "PyRuntimeWarning"

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

impl PyTypeInfo for PyStopAsyncIteration

type AsRefTarget = PyStopAsyncIteration

const NAME: &'static str = "PyStopAsyncIteration"

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

impl PyTypeInfo for PyStopIteration

type AsRefTarget = PyStopIteration

const NAME: &'static str = "PyStopIteration"

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

impl PyTypeInfo for PySyntaxError

type AsRefTarget = PySyntaxError

const NAME: &'static str = "PySyntaxError"

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

impl PyTypeInfo for PySyntaxWarning

type AsRefTarget = PySyntaxWarning

const NAME: &'static str = "PySyntaxWarning"

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

impl PyTypeInfo for PySystemError

type AsRefTarget = PySystemError

const NAME: &'static str = "PySystemError"

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

impl PyTypeInfo for PySystemExit

type AsRefTarget = PySystemExit

const NAME: &'static str = "PySystemExit"

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

impl PyTypeInfo for PyTimeoutError

type AsRefTarget = PyTimeoutError

const NAME: &'static str = "PyTimeoutError"

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

impl PyTypeInfo for PyTypeError

type AsRefTarget = PyTypeError

const NAME: &'static str = "PyTypeError"

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

impl PyTypeInfo for PyUnboundLocalError

type AsRefTarget = PyUnboundLocalError

const NAME: &'static str = "PyUnboundLocalError"

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

impl PyTypeInfo for PyUnicodeDecodeError

type AsRefTarget = PyUnicodeDecodeError

const NAME: &'static str = "PyUnicodeDecodeError"

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

impl PyTypeInfo for PyUnicodeEncodeError

type AsRefTarget = PyUnicodeEncodeError

const NAME: &'static str = "PyUnicodeEncodeError"

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

impl PyTypeInfo for PyUnicodeError

type AsRefTarget = PyUnicodeError

const NAME: &'static str = "PyUnicodeError"

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

impl PyTypeInfo for PyUnicodeTranslateError

type AsRefTarget = PyUnicodeTranslateError

const NAME: &'static str = "PyUnicodeTranslateError"

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

impl PyTypeInfo for PyUnicodeWarning

type AsRefTarget = PyUnicodeWarning

const NAME: &'static str = "PyUnicodeWarning"

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

impl PyTypeInfo for PyUserWarning

type AsRefTarget = PyUserWarning

const NAME: &'static str = "PyUserWarning"

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

impl PyTypeInfo for PyValueError

type AsRefTarget = PyValueError

const NAME: &'static str = "PyValueError"

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

impl PyTypeInfo for PyWarning

type AsRefTarget = PyWarning

const NAME: &'static str = "PyWarning"

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

impl PyTypeInfo for PyZeroDivisionError

type AsRefTarget = PyZeroDivisionError

const NAME: &'static str = "PyZeroDivisionError"

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

impl PyTypeInfo for PanicException

type AsRefTarget = PanicException

const NAME: &'static str = "PanicException"

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

impl PyTypeInfo for PyAny

type AsRefTarget = PyAny

const NAME: &'static str = "PyAny"

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

impl PyTypeInfo for PyBool

type AsRefTarget = PyBool

const NAME: &'static str = "PyBool"

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

impl PyTypeInfo for PyByteArray

type AsRefTarget = PyByteArray

const NAME: &'static str = "PyByteArray"

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

impl PyTypeInfo for PyBytes

type AsRefTarget = PyBytes

const NAME: &'static str = "PyBytes"

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

impl PyTypeInfo for PyCFunction

type AsRefTarget = PyCFunction

const NAME: &'static str = "PyCFunction"

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

impl PyTypeInfo for PyCapsule

type AsRefTarget = PyCapsule

const NAME: &'static str = "PyCapsule"

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

impl PyTypeInfo for PyCode

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyCode

const NAME: &'static str = "PyCode"

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

impl PyTypeInfo for PyComplex

type AsRefTarget = PyComplex

const NAME: &'static str = "PyComplex"

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

impl PyTypeInfo for PyDate

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyDate

const NAME: &'static str = "PyDate"

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

impl PyTypeInfo for PyDateTime

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyDateTime

const NAME: &'static str = "PyDateTime"

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

impl PyTypeInfo for PyDelta

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyDelta

const NAME: &'static str = "PyDelta"

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

impl PyTypeInfo for PyDict

type AsRefTarget = PyDict

const NAME: &'static str = "PyDict"

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

impl PyTypeInfo for PyDictItems

type AsRefTarget = PyDictItems

const NAME: &'static str = "PyDictItems"

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

impl PyTypeInfo for PyDictKeys

type AsRefTarget = PyDictKeys

const NAME: &'static str = "PyDictKeys"

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

impl PyTypeInfo for PyDictValues

type AsRefTarget = PyDictValues

const NAME: &'static str = "PyDictValues"

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

impl PyTypeInfo for PyFloat

type AsRefTarget = PyFloat

const NAME: &'static str = "PyFloat"

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

impl PyTypeInfo for PyFrame

Available on non-Py_LIMITED_API and non-PyPy only.

type AsRefTarget = PyFrame

const NAME: &'static str = "PyFrame"

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

impl PyTypeInfo for PyFrozenSet

type AsRefTarget = PyFrozenSet

const NAME: &'static str = "PyFrozenSet"

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

impl PyTypeInfo for PyFunction

type AsRefTarget = PyFunction

const NAME: &'static str = "PyFunction"

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

impl PyTypeInfo for PyList

type AsRefTarget = PyList

const NAME: &'static str = "PyList"

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

impl PyTypeInfo for PyLong

type AsRefTarget = PyLong

const NAME: &'static str = "PyLong"

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

impl PyTypeInfo for PyModule

type AsRefTarget = PyModule

const NAME: &'static str = "PyModule"

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

impl PyTypeInfo for PySet

type AsRefTarget = PySet

const NAME: &'static str = "PySet"

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

impl PyTypeInfo for PySlice

type AsRefTarget = PySlice

const NAME: &'static str = "PySlice"

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

impl PyTypeInfo for PyString

type AsRefTarget = PyString

const NAME: &'static str = "PyString"

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

impl PyTypeInfo for PySuper

Available on non-PyPy only.

type AsRefTarget = PySuper

const NAME: &'static str = "PySuper"

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

impl PyTypeInfo for PyTime

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyTime

const NAME: &'static str = "PyTime"

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

impl PyTypeInfo for PyTraceback

type AsRefTarget = PyTraceback

const NAME: &'static str = "PyTraceback"

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

impl PyTypeInfo for PyTuple

type AsRefTarget = PyTuple

const NAME: &'static str = "PyTuple"

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

impl PyTypeInfo for PyType

type AsRefTarget = PyType

const NAME: &'static str = "PyType"

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

impl PyTypeInfo for PyTzInfo

Available on non-Py_LIMITED_API only.

type AsRefTarget = PyTzInfo

const NAME: &'static str = "PyTzInfo"

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