[−][src]Struct pyo3::PyAny

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

A Python object with GIL lifetime

Represents any Python object. All Python objects can be cast to PyAny. In addition, if the inner object is an instance of type T, we can downcast PyAny into T.

PyAny is used as a reference with a lifetime that represents that the GIL is held, therefore its API does not require a Python<'py> token.

See the guide for an explanation of the different Python object types.

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::<PyDict>().is_ok());
assert!(any.downcast::<PyList>().is_err());

Methods

`impl PyAny`[src]

`pub fn downcast<T>(&self) -> Result<&T, PyDowncastError> where T: PyTryFrom<'py>,` [src]

Trait Implementations

`impl AsPyPointer for PyAny`[src]

`fn as_ptr(&self) -> *mut PyObject`[src]

Gets the underlying FFI pointer, returns a borrowed pointer.

`impl AsRef<PyAny> for PyAny`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyBool`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyDict`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyFloat`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyList`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyModule`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyLong`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PySequence`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PySet`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyFrozenSet`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PySlice`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyString`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyByteArray`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyTuple`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyType`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyBytes`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyComplex`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyDate`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyDateTime`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyTime`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyTzInfo`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl AsRef<PyAny> for PyDelta`[src]

`fn as_ref(&self) -> &PyAny`[src]

`impl Debug for PyAny`[src]

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

`impl Display for PyAny`[src]

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

`impl<'a> From<&'a PyBool> for &'a PyAny`[src]

`fn from(ob: &'a PyBool) -> Self`[src]

`impl<'a> From<&'a PyByteArray> for &'a PyAny`[src]

`fn from(ob: &'a PyByteArray) -> Self`[src]

`impl<'a> From<&'a PyBytes> for &'a PyAny`[src]

`fn from(ob: &'a PyBytes) -> Self`[src]

`impl<'a> From<&'a PyComplex> for &'a PyAny`[src]

`fn from(ob: &'a PyComplex) -> Self`[src]

`impl<'a> From<&'a PyDate> for &'a PyAny`[src]

`fn from(ob: &'a PyDate) -> Self`[src]

`impl<'a> From<&'a PyDateTime> for &'a PyAny`[src]

`fn from(ob: &'a PyDateTime) -> Self`[src]

`impl<'a> From<&'a PyDelta> for &'a PyAny`[src]

`fn from(ob: &'a PyDelta) -> Self`[src]

`impl<'a> From<&'a PyDict> for &'a PyAny`[src]

`fn from(ob: &'a PyDict) -> Self`[src]

`impl<'a> From<&'a PyFloat> for &'a PyAny`[src]

`fn from(ob: &'a PyFloat) -> Self`[src]

`impl<'a> From<&'a PyFrozenSet> for &'a PyAny`[src]

`fn from(ob: &'a PyFrozenSet) -> Self`[src]

`impl<'a> From<&'a PyList> for &'a PyAny`[src]

`fn from(ob: &'a PyList) -> Self`[src]

`impl<'a> From<&'a PyLong> for &'a PyAny`[src]

`fn from(ob: &'a PyLong) -> Self`[src]

`impl<'a> From<&'a PyModule> for &'a PyAny`[src]

`fn from(ob: &'a PyModule) -> Self`[src]

`impl<'a> From<&'a PySet> for &'a PyAny`[src]

`fn from(ob: &'a PySet) -> Self`[src]

`impl<'a> From<&'a PySlice> for &'a PyAny`[src]

`fn from(ob: &'a PySlice) -> Self`[src]

`impl<'a> From<&'a PyString> for &'a PyAny`[src]

`fn from(ob: &'a PyString) -> Self`[src]

`impl<'a> From<&'a PyTime> for &'a PyAny`[src]

`fn from(ob: &'a PyTime) -> Self`[src]

`impl<'a> From<&'a PyTuple> for &'a PyAny`[src]

`fn from(ob: &'a PyTuple) -> Self`[src]

`impl<'a> From<&'a PyType> for &'a PyAny`[src]

`fn from(ob: &'a PyType) -> Self`[src]

`impl<'a> From<&'a PyTzInfo> for &'a PyAny`[src]

`fn from(ob: &'a PyTzInfo) -> Self`[src]

`impl<'py> FromPyObject<'py> for &'py PyAny`[src]

`fn extract(obj: &'py PyAny) -> PyResult<Self>`[src]

`impl PartialEq<PyAny> for PyAny`[src]

`fn eq(&self, o: &PyAny) -> bool`[src]

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

`impl PyLayout<PyAny> for PyObject`[src]

`const IS_NATIVE_TYPE: bool`[src]

`fn get_super(&mut self) -> Option<&mut T::BaseLayout>`[src]

`unsafe fn py_init(&mut self, _value: T)`[src]

`unsafe fn py_drop(&mut self, _py: Python)`[src]

`impl PyNativeType for PyAny`[src]

`fn py(&self) -> Python`[src]

`impl PySizedLayout<PyAny> for PyObject`[src]

`impl<U> PyTryInto<U> for PyAny where U: for<'v> PyTryFrom<'v>,` [src]

`fn try_into(&self) -> Result<&U, PyDowncastError>`[src]

`fn try_into_exact(&self) -> Result<&U, PyDowncastError>`[src]

`impl PyTypeInfo for PyAny`[src]

`type Type = ()`

Type of objects to store in PyObject struct

`type BaseType = PyAny`

Base class

`type Layout = PyObject`

Layout

`type BaseLayout = PyObject`

Layout of Basetype.

`type Initializer = PyNativeTypeInitializer<Self>`

Initializer for layout

`type AsRefTarget = Self`

Utility type to make AsPyRef work

`const NAME: &'static str`[src]

`const MODULE: Option<&'static str>`[src]

`fn type_object() -> &'static PyTypeObject`[src]

`fn is_instance(ptr: &PyAny) -> bool`[src]

`const DESCRIPTION: &'static str`[src]

`const FLAGS: usize`[src]

`fn is_exact_instance(object: &PyAny) -> bool`[src]

`impl ToPyObject for PyAny`[src]

`fn to_object(&self, py: Python) -> PyObject`[src]

Auto Trait Implementations

`impl !RefUnwindSafe for PyAny`

`impl !Send for PyAny`

`impl !Sync for PyAny`

`impl Unpin for PyAny`

`impl UnwindSafe for PyAny`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T> FromPy<T> for T`[src]

`fn from_py(T, Python) -> T`[src]

`impl<'p, T> FromPyPointer<'p> for T where T: 'p + PyNativeType,` [src]

`unsafe fn from_owned_ptr_or_opt(Python<'p>, *mut PyObject) -> Option<&'p T>`[src]

`unsafe fn from_borrowed_ptr_or_opt(Python<'p>, *mut PyObject) -> Option<&'p T>`[src]

`unsafe fn from_owned_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject ) -> &'p Self`[src]

`unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self`[src]

`unsafe fn from_owned_ptr_or_err( py: Python<'p>, ptr: *mut PyObject ) -> PyResult<&'p Self>`[src]

`unsafe fn from_borrowed_ptr_or_panic( py: Python<'p>, ptr: *mut PyObject ) -> &'p Self`[src]

`unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self`[src]

`unsafe fn from_borrowed_ptr_or_err( py: Python<'p>, ptr: *mut PyObject ) -> PyResult<&'p Self>`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> IntoPy<U> for T where U: FromPy<T>,` [src]

`fn into_py(Self, Python) -> U`[src]

`impl<'py, T> PyDowncastImpl for T where T: 'py + PyNativeType,` [src]

`unsafe fn unchecked_downcast(&PyAny) -> &T`[src]

`fn private(&self) -> PrivateMarker`[src]

`impl<'v, T> PyTryFrom<'v> for T where T: PyDowncastImpl + PyTypeInfo + PyNativeType,` [src]

`fn try_from<V>(V) -> Result<&'v T, PyDowncastError> where V: Into<&'v PyAny>,` [src]

`fn try_from_exact<V>(V) -> Result<&'v T, PyDowncastError> where V: Into<&'v PyAny>,` [src]

`unsafe fn try_from_unchecked<V>(V) -> &'v T where V: Into<&'v PyAny>,` [src]

`impl<T> PyTypeObject for T where T: PyTypeInfo,` [src]

`fn type_object() -> Py<PyType>`[src]

`impl<T> ToBorrowedObject for T where T: ToPyObject,` [src]

`default fn with_borrowed_ptr<F, R>(&Self, Python, F) -> R where F: FnOnce(*mut PyObject) -> R,` [src]

`impl<T> ToBorrowedObject for T where T: ToPyObject + AsPyPointer,` [src]

`fn with_borrowed_ptr<F, R>(&Self, Python, F) -> R where F: FnOnce(*mut PyObject) -> R,` [src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]