Struct PyObjectRef

pub struct PyObjectRef { /* private fields */ }

The PyObjectRef is one of the most used types. It is a reference to a python object. A single python object can have multiple references, and this reference counting is accounted for by this type. Use the .clone() method to create a new reference and increment the amount of references to the python object by 1.

Implementations

impl PyObjectRef

pub fn try_complex( &self, vm: &VirtualMachine, ) -> PyResult<Option<(Complex64, bool)>>

Tries converting a python object into a complex, returns an option of whether the complex and whether the object was a complex originally or coereced into one

impl PyObjectRef

pub fn try_to_bool(self, vm: &VirtualMachine) -> PyResult<bool>

Convert Python bool into Rust bool.

impl PyObjectRef

pub fn try_into_value<T>(self, vm: &VirtualMachine) -> PyResult<T>

where T: TryFromObject,

impl PyObjectRef

pub fn into_raw(self) -> *const PyObject

pub unsafe fn from_raw(ptr: *const PyObject) -> Self

Safety

The raw pointer must have been previously returned from a call to PyObjectRef::into_raw. The user is responsible for ensuring that the inner data is not dropped more than once due to mishandling the reference count by calling this function too many times.

pub fn downcast<T: PyObjectPayload>(self) -> Result<PyRef<T>, Self>

Attempt to downcast this reference to a subclass.

If the downcast fails, the original ref is returned in as Err so another downcast can be attempted without unnecessary cloning.

pub fn downcast_ref<T: PyObjectPayload>(&self) -> Option<&Py<T>>

pub unsafe fn downcast_unchecked<T: PyObjectPayload>(self) -> PyRef<T>

Force to downcast this reference to a subclass.

Safety

T must be the exact payload type

pub unsafe fn downcast_unchecked_ref<T: PyObjectPayload>(&self) -> &Py<T>

Safety

T must be the exact payload type

pub fn downcast_exact<T: PyObjectPayload + PyPayload>( self, vm: &VirtualMachine, ) -> Result<PyRefExact<T>, Self>

Attempt to downcast this reference to the specific class that is associated T.

If the downcast fails, the original ref is returned in as Err so another downcast can be attempted without unnecessary cloning.

impl PyObjectRef

pub fn rich_compare( self, other: Self, opid: PyComparisonOp, vm: &VirtualMachine, ) -> PyResult

pub fn bytes(self, vm: &VirtualMachine) -> PyResult

pub fn is_true(self, vm: &VirtualMachine) -> PyResult<bool>

pub fn not(self, vm: &VirtualMachine) -> PyResult<bool>

pub fn length_hint( self, defaultvalue: usize, vm: &VirtualMachine, ) -> PyResult<usize>

pub fn dir(self, vm: &VirtualMachine) -> PyResult<PyList>

Methods from Deref<Target = PyObject>

pub fn try_to_value<'a, T>(&'a self, vm: &VirtualMachine) -> PyResult<T>

where T: 'a + TryFromBorrowedObject<'a>,

pub fn try_to_ref<'a, T>(&'a self, vm: &VirtualMachine) -> PyResult<&'a Py<T>>

where T: 'a + PyPayload,

pub fn try_value_with<T, F, R>(&self, f: F, vm: &VirtualMachine) -> PyResult<R>

where T: PyPayload, F: Fn(&T) -> PyResult<R>,

pub fn try_bytes_like<R>( &self, vm: &VirtualMachine, f: impl FnOnce(&[u8]) -> R, ) -> PyResult<R>

pub fn try_rw_bytes_like<R>( &self, vm: &VirtualMachine, f: impl FnOnce(&mut [u8]) -> R, ) -> PyResult<R>

pub fn as_interned_str( &self, vm: &VirtualMachine, ) -> Option<&'static PyStrInterned>

pub fn downgrade( &self, callback: Option<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<PyRef<PyWeak>>

pub fn get_weak_references(&self) -> Option<Vec<PyRef<PyWeak>>>

pub fn payload_is<T: PyObjectPayload>(&self) -> bool

pub unsafe fn payload_unchecked<T: PyObjectPayload>(&self) -> &T

Force to return payload as T.

Safety

The actual payload type must be T.

pub fn payload<T: PyObjectPayload>(&self) -> Option<&T>

pub fn class(&self) -> &Py<PyType>

pub fn set_class(&self, typ: PyTypeRef, vm: &VirtualMachine)

pub fn payload_if_exact<T: PyObjectPayload + PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&T>

pub fn dict(&self) -> Option<PyDictRef>

pub fn set_dict(&self, dict: PyDictRef) -> Result<(), PyDictRef>

Set the dict field. Returns Err(dict) if this object does not have a dict field in the first place.

pub fn payload_if_subclass<T: PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&T>

pub fn downcast_ref<T: PyObjectPayload>(&self) -> Option<&Py<T>>

pub fn downcast_ref_if_exact<T: PyObjectPayload + PyPayload>( &self, vm: &VirtualMachine, ) -> Option<&Py<T>>

pub unsafe fn downcast_unchecked_ref<T: PyObjectPayload>(&self) -> &Py<T>

Safety

T must be the exact payload type

pub fn strong_count(&self) -> usize

pub fn weak_count(&self) -> Option<usize>

pub fn as_raw(&self) -> *const PyObject

pub fn to_callable(&self) -> Option<PyCallable<'_>>

pub fn is_callable(&self) -> bool

pub fn call(&self, args: impl IntoFuncArgs, vm: &VirtualMachine) -> PyResult

PyObject_CallArg series

pub fn call_with_args(&self, args: FuncArgs, vm: &VirtualMachine) -> PyResult

PyObject_Call

pub fn to_mapping(&self) -> PyMapping<'_>

pub fn to_number(&self) -> PyNumber<'_>

pub fn try_index_opt(&self, vm: &VirtualMachine) -> Option<PyResult<PyIntRef>>

pub fn try_index(&self, vm: &VirtualMachine) -> PyResult<PyIntRef>

pub fn try_int(&self, vm: &VirtualMachine) -> PyResult<PyIntRef>

pub fn try_float_opt( &self, vm: &VirtualMachine, ) -> Option<PyResult<PyRef<PyFloat>>>

pub fn try_float(&self, vm: &VirtualMachine) -> PyResult<PyRef<PyFloat>>

pub fn get_iter(&self, vm: &VirtualMachine) -> PyResult<PyIter>

Takes an object and returns an iterator for it. This is typically a new iterator but if the argument is an iterator, this returns itself.

pub fn get_aiter(&self, vm: &VirtualMachine) -> PyResult

pub fn has_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult<bool>

pub fn get_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult

pub fn call_set_attr( &self, vm: &VirtualMachine, attr_name: &Py<PyStr>, attr_value: PySetterValue, ) -> PyResult<()>

pub fn set_attr<'a>( &self, attr_name: impl AsPyStr<'a>, attr_value: impl Into<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<()>

pub fn generic_setattr( &self, attr_name: &Py<PyStr>, value: PySetterValue, vm: &VirtualMachine, ) -> PyResult<()>

pub fn generic_getattr(&self, name: &Py<PyStr>, vm: &VirtualMachine) -> PyResult

pub fn generic_getattr_opt( &self, name_str: &Py<PyStr>, dict: Option<PyDictRef>, vm: &VirtualMachine, ) -> PyResult<Option<PyObjectRef>>

CPython _PyObject_GenericGetAttrWithDict

pub fn del_attr<'a>( &self, attr_name: impl AsPyStr<'a>, vm: &VirtualMachine, ) -> PyResult<()>

pub fn rich_compare_bool( &self, other: &Self, opid: PyComparisonOp, vm: &VirtualMachine, ) -> PyResult<bool>

pub fn repr(&self, vm: &VirtualMachine) -> PyResult<PyStrRef>

pub fn ascii(&self, vm: &VirtualMachine) -> PyResult<AsciiString>

pub fn str(&self, vm: &VirtualMachine) -> PyResult<PyStrRef>

pub fn is_subclass(&self, cls: &PyObject, vm: &VirtualMachine) -> PyResult<bool>

Determines if self is a subclass of cls, either directly, indirectly or virtually via the subclasscheck magic method.

pub fn is_instance(&self, cls: &PyObject, vm: &VirtualMachine) -> PyResult<bool>

Determines if self is an instance of cls, either directly, indirectly or virtually via the instancecheck magic method.

pub fn hash(&self, vm: &VirtualMachine) -> PyResult<PyHash>

pub fn obj_type(&self) -> PyObjectRef

pub fn type_check(&self, typ: &Py<PyType>) -> bool

pub fn length_opt(&self, vm: &VirtualMachine) -> Option<PyResult<usize>>

pub fn length(&self, vm: &VirtualMachine) -> PyResult<usize>

pub fn get_item<K: DictKey + ?Sized>( &self, needle: &K, vm: &VirtualMachine, ) -> PyResult

pub fn set_item<K: DictKey + ?Sized>( &self, needle: &K, value: PyObjectRef, vm: &VirtualMachine, ) -> PyResult<()>

pub fn del_item<K: DictKey + ?Sized>( &self, needle: &K, vm: &VirtualMachine, ) -> PyResult<()>

pub fn to_sequence(&self) -> PySequence<'_>

Trait Implementations

impl AsRef<PyObject> for PyObjectRef

fn as_ref(&self) -> &PyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<PyObject> for PyObjectRef

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value.

impl Clone for PyObjectRef

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PyObjectRef

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

Formats the value using the given formatter.

impl Deref for PyObjectRef

type Target = PyObject

The resulting type after dereferencing.

fn deref(&self) -> &PyObject

Dereferences the value.

impl Drop for PyObjectRef

fn drop(&mut self)

Executes the destructor for this type.

impl Dumpable for PyObjectRef

type Error = DumpError

type Constant = Literal

fn with_dump<R>( &self, f: impl FnOnce(DumpableValue<'_, Self>) -> R, ) -> Result<R, Self::Error>

impl From<ArgCallable> for PyObjectRef

fn from(value: ArgCallable) -> PyObjectRef

Converts to this type from the input type.

impl From<ArgMapping> for PyObjectRef

fn from(value: ArgMapping) -> PyObjectRef

Converts to this type from the input type.

impl<A: Into<PyObjectRef>, B: Into<PyObjectRef>> From<Either<A, B>> for PyObjectRef

fn from(value: Either<A, B>) -> Self

Converts to this type from the input type.

impl From<PyIter> for PyObjectRef

fn from(value: PyIter<PyObjectRef>) -> PyObjectRef

Converts to this type from the input type.

impl From<PyObjectRef> for PyAtomicRef<PyObject>

fn from(obj: PyObjectRef) -> Self

Converts to this type from the input type.

impl From<PyObjectRef> for PyClassMethod

fn from(callable: PyObjectRef) -> Self

Converts to this type from the input type.

impl From<PyObjectRef> for PyStaticMethod

fn from(callable: PyObjectRef) -> Self

Converts to this type from the input type.

impl<T> From<PyRef<T>> for PyObjectRef

where T: PyObjectPayload,

fn from(value: PyRef<T>) -> Self

Converts to this type from the input type.

impl FromIterator<PyObjectRef> for PyList

fn from_iter<T: IntoIterator<Item = PyObjectRef>>(iter: T) -> Self

Creates a value from an iterator.

impl ToPyObject for PyObjectRef

fn to_pyobject(self, _vm: &VirtualMachine) -> PyObjectRef

impl Traverse for PyObjectRef

fn traverse(&self, traverse_fn: &mut TraverseFn<'_>)

impl traverse() with caution! Following those guideline so traverse doesn’t cause memory error!:

impl TryFromObject for PyObjectRef

fn try_from_object(_vm: &VirtualMachine, obj: PyObjectRef) -> PyResult<Self>

Attempt to convert a Python object to a value of this type.