Struct pyo3::types::PyAny

#[repr(transparent)]
pub struct PyAny(_);

Represents a python's Any type. We can convert all python objects as PyAny.

In addition, if the inner object is an instance of type T, we can downcast PyAny into T.

Example

use pyo3::prelude::*;
use pyo3::types::{PyAny, PyDict, PyList};
let gil = Python::acquire_gil();
let dict = PyDict::new(gil.python());
assert!(gil.python().is_instance::<PyAny, _>(dict).unwrap());
let any = dict.as_ref();
assert!(any.downcast_ref::<PyDict>().is_ok());
assert!(any.downcast_ref::<PyList>().is_err());

Methods

impl PyAny

pub fn downcast_ref<T>(&self) -> Result<&T, PyDowncastError> where
    T: for<'gil> PyTryFrom<'gil>, 

pub fn downcast_mut<T>(&self) -> Result<&mut T, PyDowncastError> where
    T: for<'gil> PyTryFrom<'gil>, 

Trait Implementations

impl AsPyPointer for PyAny

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PyAny

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl<U> PyTryInto<U> for PyAny where
    U: for<'v> PyTryFrom<'v>, 

fn try_into(&self) -> Result<&U, PyDowncastError>

Cast from PyObject to a concrete Python object type.

fn try_into_exact(&self) -> Result<&U, PyDowncastError>

Cast from PyObject to a concrete Python object type. With exact type check.

fn try_into_mut(&self) -> Result<&mut U, PyDowncastError>

Cast from PyObject to a concrete Python object type.

fn try_into_mut_exact(&self) -> Result<&mut U, PyDowncastError>

Cast from PyObject to a concrete Python object type. With exact type check.

impl PyNativeType for PyAny

fn py(&self) -> Python

impl AsPyRef<PyAny> for PyObject

fn as_ref(&self, _py: Python) -> PyRef<PyAny>

Return reference to object.

fn as_mut(&mut self, _py: Python) -> PyRefMut<PyAny>

Return mutable reference to object.

fn with<F, R>(&self, f: F) -> R where
    F: FnOnce(Python, PyRef<T>) -> R, 

Acquire python gil and call closure with object reference.

fn with_mut<F, R>(&mut self, f: F) -> R where
    F: FnOnce(Python, PyRefMut<T>) -> R, 

Acquire python gil and call closure with mutable object reference.

fn into_py<F, R>(self, f: F) -> R where
    Self: IntoPyPointer,
    F: FnOnce(Python, PyRef<T>) -> R, 

fn into_mut_py<F, R>(self, f: F) -> R where
    Self: IntoPyPointer,
    F: FnOnce(Python, PyRefMut<T>) -> R, 

impl PyTypeInfo for PyAny

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

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

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

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

impl PyObjectAlloc for PyAny

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeObject for PyAny

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl<'a, T> From<PyRef<'a, T>> for &'a PyAny where
    T: PyTypeInfo, 

fn from(pref: PyRef<'a, T>) -> &'a PyAny

Performs the conversion.

impl<'a, T> From<PyRefMut<'a, T>> for &'a PyAny where
    T: PyTypeInfo, 

fn from(pref: PyRefMut<'a, T>) -> &'a PyAny

Performs the conversion.

impl<'a> From<&'a PyBool> for &'a PyAny

fn from(ob: &'a PyBool) -> Self

Performs the conversion.

impl<'a> From<&'a PyByteArray> for &'a PyAny

fn from(ob: &'a PyByteArray) -> Self

Performs the conversion.

impl<'a> From<&'a PyComplex> for &'a PyAny

fn from(ob: &'a PyComplex) -> Self

Performs the conversion.

impl<'a> From<&'a PyDate> for &'a PyAny

fn from(ob: &'a PyDate) -> Self

Performs the conversion.

impl<'a> From<&'a PyDateTime> for &'a PyAny

fn from(ob: &'a PyDateTime) -> Self

Performs the conversion.

impl<'a> From<&'a PyTime> for &'a PyAny

fn from(ob: &'a PyTime) -> Self

Performs the conversion.

impl<'a> From<&'a PyTzInfo> for &'a PyAny

fn from(ob: &'a PyTzInfo) -> Self

Performs the conversion.

impl<'a> From<&'a PyDelta> for &'a PyAny

fn from(ob: &'a PyDelta) -> Self

Performs the conversion.

impl<'a> From<&'a PyDict> for &'a PyAny

fn from(ob: &'a PyDict) -> Self

Performs the conversion.

impl<'a> From<&'a PyFloat> for &'a PyAny

fn from(ob: &'a PyFloat) -> Self

Performs the conversion.

impl<'a> From<&'a PyList> for &'a PyAny

fn from(ob: &'a PyList) -> Self

Performs the conversion.

impl<'a> From<&'a PyModule> for &'a PyAny

fn from(ob: &'a PyModule) -> Self

Performs the conversion.

impl<'a> From<&'a PyLong> for &'a PyAny

fn from(ob: &'a PyLong) -> Self

Performs the conversion.

impl<'a> From<&'a PySet> for &'a PyAny

fn from(ob: &'a PySet) -> Self

Performs the conversion.

impl<'a> From<&'a PyFrozenSet> for &'a PyAny

fn from(ob: &'a PyFrozenSet) -> Self

Performs the conversion.

impl<'a> From<&'a PySlice> for &'a PyAny

fn from(ob: &'a PySlice) -> Self

Performs the conversion.

impl<'a> From<&'a PyString> for &'a PyAny

fn from(ob: &'a PyString) -> Self

Performs the conversion.

impl<'a> From<&'a PyBytes> for &'a PyAny

fn from(ob: &'a PyBytes) -> Self

Performs the conversion.

impl<'a> From<&'a PyTuple> for &'a PyAny

fn from(ob: &'a PyTuple) -> Self

Performs the conversion.

impl<'a> From<&'a PyType> for &'a PyAny

fn from(ob: &'a PyType) -> Self

Performs the conversion.

impl PartialEq<PyAny> for PyAny

fn eq(&self, o: &PyAny) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl AsRef<PyAny> for PyAny

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyBool

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyByteArray

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyComplex

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDate

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDateTime

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTime

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTzInfo

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDelta

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyDict

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyFloat

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyList

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyModule

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyLong

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySequence

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyFrozenSet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PySlice

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyString

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyBytes

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyTuple

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl AsRef<PyAny> for PyType

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Display for PyAny

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Debug for PyAny

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.