Trait pyo3::type_object::PyTypeInfo

[+] Show declaration

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 { ... }
}

[−] 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

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

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)

Required methods

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

PyTypeObject instance for this type.

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

Implementors

impl PyTypeInfo for PyModule[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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 BlockerResult

impl PyTypeInfo for FilterSet

impl PyTypeInfo for UrlSpecificResources

impl PyTypeInfo for Engine