Type Definition pyo3::prelude::PyObject

pub type PyObject = Py<PyAny>;

A commonly-used alias for Py<PyAny>.

This is an owned reference a Python object without any type information. This value can also be safely sent between threads.

See the documentation for Py.

Implementations

impl PyObject

pub fn downcast<'p, T>(
    &'p self,
    py: Python<'p>
) -> Result<&T, PyDowncastError<'_>>where
    T: PyTryFrom<'p>,

Casts the PyObject to a concrete Python object type.

This can cast only to native Python types, not types implemented in Rust. For a more flexible alternative, see Py::extract.

pub unsafe fn downcast_unchecked<'p, T>(&'p self, py: Python<'p>) -> &Twhere
    T: PyTryFrom<'p>,

Casts the PyObject to a concrete Python object type without checking validity.

This can cast only to native Python types, not types implemented in Rust. For a more flexible alternative, see Py::extract.

Safety

Callers must ensure that the type is valid or risk type confusion.

pub fn cast_as<'p, D>(
    &'p self,
    py: Python<'p>
) -> Result<&'p D, PyDowncastError<'_>>where
    D: PyTryFrom<'p>,

👎Deprecated since 0.18.0: use downcast() instead

Casts the PyObject to a concrete Python object type.

Trait Implementations

impl<T> From<&T> for PyObjectwhere
    T: AsPyPointer + PyNativeType,

fn from(obj: &T) -> Self

Converts to this type from the input type.

impl<T> From<Py<T>> for PyObjectwhere
    T: AsRef<PyAny>,

fn from(other: Py<T>) -> Self

Converts to this type from the input type.