Struct pyo3::types::PyObjectRef

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

Represents general python instance.

Trait Implementations

impl ToPyObject for PyObjectRef

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

Converts self into a Python object.

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

type Error = PyDowncastError

The type returned in the event of a conversion error.

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 PyObjectWithGIL for PyObjectRef

fn py(&self) -> Python

impl AsPyRef<PyObjectRef> for PyObject

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

Return reference to object.

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

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 ToPyPointer for PyObjectRef

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl PyTypeInfo for PyObjectRef

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyObjectRef

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: &PyObjectRef) -> 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: &PyObjectRef) -> bool

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

impl PyObjectAlloc for PyObjectRef

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 PyObjectRef

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 PyObjectRef where
    T: PyTypeInfo, 

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

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

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

Performs the conversion.

impl PartialEq<PyObjectRef> for PyObjectRef

fn eq(&self, o: &PyObjectRef) -> 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<PyObjectRef> for PyObjectRef

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyBool

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyByteArray

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyComplex

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyDate

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyDateTime

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyTime

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyTzInfo

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyDelta

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyDict

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyFloat

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyList

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyModule

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PySequence

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PySet

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyFrozenSet

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PySlice

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyTuple

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyType

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyLong

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyString

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl AsRef<PyObjectRef> for PyBytes

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl Display for PyObjectRef

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

Formats the value using the given formatter.

impl Debug for PyObjectRef

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

Formats the value using the given formatter.