Trait PyNativeType

pub unsafe trait PyNativeType: Sized {
    type AsRefSource: HasPyGilRef<AsRefTarget = Self>;

    // Provided methods
    fn as_borrowed(&self) -> Borrowed<'_, '_, Self::AsRefSource> { ... }
    fn py(&self) -> Python<'_> { ... }
    unsafe fn unchecked_downcast(obj: &PyAny) -> &Self { ... }
}

Available on crate feature gil-refs only.

Expand description

Types that are built into the Python interpreter.

PyO3 is designed in a way that all references to those types are bound to the GIL, which is why you can get a token from all references of those types.

§Safety

This trait must only be implemented for types which cannot be accessed without the GIL.

Required Associated Types§

type AsRefSource: HasPyGilRef<AsRefTarget = Self>

The form of this which is stored inside a Py<T> smart pointer.

Provided Methods§

fn as_borrowed(&self) -> Borrowed<'_, '_, Self::AsRefSource>

Cast &self to a Borrowed smart pointer.

Borrowed<T> implements Deref<Target=Bound<T>>, so can also be used in locations where Bound<T> is expected.

This is available as a migration tool to adjust code from the deprecated “GIL Refs” API to the Bound smart pointer API.

fn py(&self) -> Python<'_>

Returns a GIL marker constrained to the lifetime of this type.

unsafe fn unchecked_downcast(obj: &PyAny) -> &Self

Cast &PyAny to &Self without no type checking.

§Safety

obj must have the same layout as *const ffi::PyObject and must be an instance of a type corresponding to Self.

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§

impl PyNativeType for CancelledError

type AsRefSource = CancelledError

impl PyNativeType for IncompleteReadError

type AsRefSource = IncompleteReadError

impl PyNativeType for InvalidStateError

type AsRefSource = InvalidStateError

impl PyNativeType for LimitOverrunError

type AsRefSource = LimitOverrunError

impl PyNativeType for QueueEmpty

type AsRefSource = QueueEmpty

impl PyNativeType for QueueFull

type AsRefSource = QueueFull

impl PyNativeType for TimeoutError

type AsRefSource = TimeoutError

impl PyNativeType for gaierror

type AsRefSource = gaierror

impl PyNativeType for herror

type AsRefSource = herror

impl PyNativeType for timeout

type AsRefSource = timeout

impl PyNativeType for PyArithmeticError

type AsRefSource = PyArithmeticError

impl PyNativeType for PyAssertionError

type AsRefSource = PyAssertionError

impl PyNativeType for PyAttributeError

type AsRefSource = PyAttributeError

impl PyNativeType for PyBaseException

type AsRefSource = PyBaseException

impl PyNativeType for PyBlockingIOError

type AsRefSource = PyBlockingIOError

impl PyNativeType for PyBrokenPipeError

type AsRefSource = PyBrokenPipeError

impl PyNativeType for PyBufferError

type AsRefSource = PyBufferError

impl PyNativeType for PyBytesWarning

type AsRefSource = PyBytesWarning

impl PyNativeType for PyChildProcessError

type AsRefSource = PyChildProcessError

impl PyNativeType for PyConnectionAbortedError

type AsRefSource = PyConnectionAbortedError

impl PyNativeType for PyConnectionError

type AsRefSource = PyConnectionError

impl PyNativeType for PyConnectionRefusedError

type AsRefSource = PyConnectionRefusedError

impl PyNativeType for PyConnectionResetError

type AsRefSource = PyConnectionResetError

impl PyNativeType for PyDeprecationWarning

type AsRefSource = PyDeprecationWarning

impl PyNativeType for PyEOFError

type AsRefSource = PyEOFError

impl PyNativeType for PyEncodingWarning

type AsRefSource = PyEncodingWarning

impl PyNativeType for PyEnvironmentError

type AsRefSource = PyEnvironmentError

impl PyNativeType for PyException

type AsRefSource = PyException

impl PyNativeType for PyFileExistsError

type AsRefSource = PyFileExistsError

impl PyNativeType for PyFileNotFoundError

type AsRefSource = PyFileNotFoundError

impl PyNativeType for PyFloatingPointError

type AsRefSource = PyFloatingPointError

impl PyNativeType for PyFutureWarning

type AsRefSource = PyFutureWarning

impl PyNativeType for PyGeneratorExit

type AsRefSource = PyGeneratorExit

impl PyNativeType for PyIOError

type AsRefSource = PyIOError

impl PyNativeType for PyImportError

type AsRefSource = PyImportError

impl PyNativeType for PyImportWarning

type AsRefSource = PyImportWarning

impl PyNativeType for PyIndexError

type AsRefSource = PyIndexError

impl PyNativeType for PyInterruptedError

type AsRefSource = PyInterruptedError

impl PyNativeType for PyIsADirectoryError

type AsRefSource = PyIsADirectoryError

impl PyNativeType for PyKeyError

type AsRefSource = PyKeyError

impl PyNativeType for PyKeyboardInterrupt

type AsRefSource = PyKeyboardInterrupt

impl PyNativeType for PyLookupError

type AsRefSource = PyLookupError

impl PyNativeType for PyMemoryError

type AsRefSource = PyMemoryError

impl PyNativeType for PyModuleNotFoundError

type AsRefSource = PyModuleNotFoundError

impl PyNativeType for PyNameError

type AsRefSource = PyNameError

impl PyNativeType for PyNotADirectoryError

type AsRefSource = PyNotADirectoryError

impl PyNativeType for PyNotImplementedError

type AsRefSource = PyNotImplementedError

impl PyNativeType for PyOSError

type AsRefSource = PyOSError

impl PyNativeType for PyOverflowError

type AsRefSource = PyOverflowError

impl PyNativeType for PyPendingDeprecationWarning

type AsRefSource = PyPendingDeprecationWarning

impl PyNativeType for PyPermissionError

type AsRefSource = PyPermissionError

impl PyNativeType for PyProcessLookupError

type AsRefSource = PyProcessLookupError

impl PyNativeType for PyRecursionError

type AsRefSource = PyRecursionError

impl PyNativeType for PyReferenceError

type AsRefSource = PyReferenceError

impl PyNativeType for PyResourceWarning

type AsRefSource = PyResourceWarning

impl PyNativeType for PyRuntimeError

type AsRefSource = PyRuntimeError

impl PyNativeType for PyRuntimeWarning

type AsRefSource = PyRuntimeWarning

impl PyNativeType for PyStopAsyncIteration

type AsRefSource = PyStopAsyncIteration

impl PyNativeType for PyStopIteration

type AsRefSource = PyStopIteration

impl PyNativeType for PySyntaxError

type AsRefSource = PySyntaxError

impl PyNativeType for PySyntaxWarning

type AsRefSource = PySyntaxWarning

impl PyNativeType for PySystemError

type AsRefSource = PySystemError

impl PyNativeType for PySystemExit

type AsRefSource = PySystemExit

impl PyNativeType for PyTimeoutError

type AsRefSource = PyTimeoutError

impl PyNativeType for PyTypeError

type AsRefSource = PyTypeError

impl PyNativeType for PyUnboundLocalError

type AsRefSource = PyUnboundLocalError

impl PyNativeType for PyUnicodeDecodeError

type AsRefSource = PyUnicodeDecodeError

impl PyNativeType for PyUnicodeEncodeError

type AsRefSource = PyUnicodeEncodeError

impl PyNativeType for PyUnicodeError

type AsRefSource = PyUnicodeError

impl PyNativeType for PyUnicodeTranslateError

type AsRefSource = PyUnicodeTranslateError

impl PyNativeType for PyUnicodeWarning

type AsRefSource = PyUnicodeWarning

impl PyNativeType for PyUserWarning

type AsRefSource = PyUserWarning

impl PyNativeType for PyValueError

type AsRefSource = PyValueError

impl PyNativeType for PyWarning

type AsRefSource = PyWarning

impl PyNativeType for PyZeroDivisionError

type AsRefSource = PyZeroDivisionError

impl PyNativeType for PanicException

type AsRefSource = PanicException

impl PyNativeType for PyAny

type AsRefSource = PyAny

impl PyNativeType for PyBool

type AsRefSource = PyBool

impl PyNativeType for PyByteArray

type AsRefSource = PyByteArray

impl PyNativeType for PyBytes

type AsRefSource = PyBytes

impl PyNativeType for PyCFunction

type AsRefSource = PyCFunction

impl PyNativeType for PyCapsule

type AsRefSource = PyCapsule

impl PyNativeType for PyCode

Available on non-Py_LIMITED_API and non-PyPy and non-GraalPy only.

type AsRefSource = PyCode

impl PyNativeType for PyComplex

type AsRefSource = PyComplex

impl PyNativeType for PyDate

Available on non-Py_LIMITED_API only.

type AsRefSource = PyDate

impl PyNativeType for PyDateTime

Available on non-Py_LIMITED_API only.

type AsRefSource = PyDateTime

impl PyNativeType for PyDelta

Available on non-Py_LIMITED_API only.

type AsRefSource = PyDelta

impl PyNativeType for PyDict

type AsRefSource = PyDict

impl PyNativeType for PyDictItems

type AsRefSource = PyDictItems

impl PyNativeType for PyDictKeys

type AsRefSource = PyDictKeys

impl PyNativeType for PyDictValues

type AsRefSource = PyDictValues

impl PyNativeType for PyEllipsis

type AsRefSource = PyEllipsis

impl PyNativeType for PyFloat

type AsRefSource = PyFloat

impl PyNativeType for PyFrame

Available on non-Py_LIMITED_API and non-PyPy and non-GraalPy only.

type AsRefSource = PyFrame

impl PyNativeType for PyFrozenSet

type AsRefSource = PyFrozenSet

impl PyNativeType for PyFunction

type AsRefSource = PyFunction

impl PyNativeType for PyIterator

type AsRefSource = PyIterator

impl PyNativeType for PyList

type AsRefSource = PyList

impl PyNativeType for PyLong

type AsRefSource = PyLong

impl PyNativeType for PyMapping

type AsRefSource = PyMapping

impl PyNativeType for PyMemoryView

type AsRefSource = PyMemoryView

impl PyNativeType for PyModule

type AsRefSource = PyModule

impl PyNativeType for PyNone

type AsRefSource = PyNone

impl PyNativeType for PyNotImplemented

type AsRefSource = PyNotImplemented

impl PyNativeType for PySequence

type AsRefSource = PySequence

impl PyNativeType for PySet

type AsRefSource = PySet

impl PyNativeType for PySlice

type AsRefSource = PySlice

impl PyNativeType for PyString

type AsRefSource = PyString

impl PyNativeType for PySuper

Available on neither PyPy nor GraalPy.

type AsRefSource = PySuper

impl PyNativeType for PyTime

Available on non-Py_LIMITED_API only.

type AsRefSource = PyTime

impl PyNativeType for PyTraceback

type AsRefSource = PyTraceback

impl PyNativeType for PyTuple

type AsRefSource = PyTuple

impl PyNativeType for PyType

type AsRefSource = PyType

impl PyNativeType for PyTzInfo

Available on non-Py_LIMITED_API only.

type AsRefSource = PyTzInfo

impl PyNativeType for PyWeakref

type AsRefSource = PyWeakref

impl PyNativeType for PyWeakrefProxy

type AsRefSource = PyWeakrefProxy

impl PyNativeType for PyWeakrefReference

type AsRefSource = PyWeakrefReference

impl<T: PyClass> PyNativeType for PyCell<T>

type AsRefSource = T