Trait pyo3::type_object::PyTypeInfo

pub unsafe trait PyTypeInfo: Sized {
    type Type;
    type BaseType: PyTypeInfo + PyTypeObject;
    type Layout: PyLayout<Self>;
    type BaseLayout: PySizedLayout<Self::BaseType>;
    type Initializer: PyObjectInit<Self>;
    type AsRefTarget: PyNativeType;

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

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

    fn is_instance(object: &PyAny) -> bool { ... }
    fn is_exact_instance(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

Associated Types

type Type

Type of objects to store in PyObject struct

type BaseType: PyTypeInfo + PyTypeObject

Base class

type Layout: PyLayout<Self>

Layout

type BaseLayout: PySizedLayout<Self::BaseType>

Layout of Basetype.

type Initializer: PyObjectInit<Self>

Initializer for layout

type AsRefTarget: PyNativeType

Utility type to make AsPyRef work

Loading content...

Associated Constants

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

Loading content...

Required methods

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

PyTypeObject instance for this type.

Loading content...

Provided methods

fn is_instance(object: &PyAny) -> bool

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

fn is_exact_instance(object: &PyAny) -> bool

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

Loading content...

Implementors

impl PyTypeInfo for PyModule

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyAny

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyBool

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyByteArray

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyBytes

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyComplex

type Type = ()

type BaseType = PyAny

type Layout = PyComplexObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyDate

type Type = ()

type BaseType = PyAny

type Layout = PyDateTime_Date

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyDateTime

type Type = ()

type BaseType = PyAny

type Layout = PyDateTime_DateTime

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyDelta

type Type = ()

type BaseType = PyAny

type Layout = PyDateTime_Delta

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyDict

type Type = ()

type BaseType = PyAny

type Layout = PyDictObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyFloat

type Type = ()

type BaseType = PyAny

type Layout = PyFloatObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyFrozenSet

type Type = ()

type BaseType = PyAny

type Layout = PySetObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyList

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyLong

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PySet

type Type = ()

type BaseType = PyAny

type Layout = PySetObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PySlice

type Type = ()

type BaseType = PyAny

type Layout = PySliceObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyString

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyTime

type Type = ()

type BaseType = PyAny

type Layout = PyDateTime_Time

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyTuple

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyType

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

impl PyTypeInfo for PyTzInfo

type Type = ()

type BaseType = PyAny

type Layout = PyObject

type BaseLayout = PyObject

type Initializer = PyNativeTypeInitializer<Self>

type AsRefTarget = Self

const NAME: &'static str

const MODULE: Option<&'static str>

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

fn is_instance(ptr: &PyAny) -> bool

Loading content...