Trait pyo3::type_object::PyTypeInfo

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

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

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

    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.

Associated Types

type AsRefTarget: PyNativeType

Utility type to make Py::as_ref work.

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

PyTypeObject instance for this type.

Provided methods

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.

Implementors

impl PyTypeInfo for CancelledError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for IncompleteReadError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for InvalidStateError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for LimitOverrunError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for QueueEmpty

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for QueueFull

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for TimeoutError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for gaierror

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for herror

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for timeout

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyArithmeticError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyAssertionError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyAttributeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBaseException

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBlockingIOError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBrokenPipeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBufferError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyChildProcessError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionAbortedError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionRefusedError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionResetError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyEOFError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyEnvironmentError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyException

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFileExistsError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFileNotFoundError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFloatingPointError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyGeneratorExit

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyIOError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyImportError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyIndexError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyInterruptedError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyIsADirectoryError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyKeyError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyKeyboardInterrupt

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyLookupError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyMemoryError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyModuleNotFoundError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyNameError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyNotADirectoryError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyNotImplementedError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyOSError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyOverflowError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyPermissionError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyProcessLookupError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyRecursionError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyReferenceError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyRuntimeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyStopAsyncIteration

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyStopIteration

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PySyntaxError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PySystemError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PySystemExit

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTimeoutError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTypeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyUnboundLocalError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyUnicodeDecodeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyUnicodeEncodeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyUnicodeError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyUnicodeTranslateError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyValueError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyZeroDivisionError

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PanicException

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyAny

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyModule

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBool

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyByteArray

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBytes

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyCFunction

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyCapsule

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyComplex

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyDate

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyDateTime

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyDelta

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyDict

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFloat

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFrozenSet

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyFunction

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyList

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyLong

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PySet

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PySlice

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyString

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTime

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTraceback

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTuple

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyType

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

impl PyTypeInfo for PyTzInfo

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>