devela::_dep::pyo3

Trait PyTypeInfo

pub unsafe trait PyTypeInfo: Sized {
    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<'_>) -> Bound<'_, PyType> { ... }
    fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType> { ... }
    fn is_type_of(object: &Bound<'_, PyAny>) -> bool { ... }
    fn is_type_of_bound(object: &Bound<'_, PyAny>) -> bool { ... }
    fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool { ... }
    fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool { ... }
}

Available on crate features dep_pyo3 and std only.

Expand description

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 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<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::type_object.

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

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

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

§

Trait PyTypeInfoCopy item path

§Safety

Required Associated Constants§

const NAME: &'static str

const MODULE: Option<&'static str>

Required Methods§

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

Provided Methods§

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

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

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

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

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

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

Dyn Compatibility§

Implementors§

impl PyTypeInfo for CancelledError

const NAME: &'static str = "CancelledError"

const MODULE: Option<&'static str>

impl PyTypeInfo for IncompleteReadError

const NAME: &'static str = "IncompleteReadError"

const MODULE: Option<&'static str>

impl PyTypeInfo for InvalidStateError

const NAME: &'static str = "InvalidStateError"

const MODULE: Option<&'static str>

impl PyTypeInfo for LimitOverrunError

const NAME: &'static str = "LimitOverrunError"

const MODULE: Option<&'static str>

impl PyTypeInfo for QueueEmpty

const NAME: &'static str = "QueueEmpty"

const MODULE: Option<&'static str>

impl PyTypeInfo for QueueFull

const NAME: &'static str = "QueueFull"

const MODULE: Option<&'static str>

impl PyTypeInfo for TimeoutError

const NAME: &'static str = "TimeoutError"

const MODULE: Option<&'static str>

impl PyTypeInfo for gaierror

const NAME: &'static str = "gaierror"

const MODULE: Option<&'static str>

impl PyTypeInfo for herror

const NAME: &'static str = "herror"

const MODULE: Option<&'static str>

impl PyTypeInfo for timeout

const NAME: &'static str = "timeout"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyArithmeticError

const NAME: &'static str = "PyArithmeticError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyAssertionError

const NAME: &'static str = "PyAssertionError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyAttributeError

const NAME: &'static str = "PyAttributeError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBaseException

const NAME: &'static str = "PyBaseException"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBlockingIOError

const NAME: &'static str = "PyBlockingIOError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBrokenPipeError

const NAME: &'static str = "PyBrokenPipeError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBufferError

const NAME: &'static str = "PyBufferError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyBytesWarning

const NAME: &'static str = "PyBytesWarning"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyChildProcessError

const NAME: &'static str = "PyChildProcessError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionAbortedError

const NAME: &'static str = "PyConnectionAbortedError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionError

const NAME: &'static str = "PyConnectionError"

const MODULE: Option<&'static str>

impl PyTypeInfo for PyConnectionRefusedError

Trait PyTypeInfo