Struct rustpython_vm::object::PyRef

#[repr(transparent)]
pub struct PyRef<T: PyObjectPayload> { /* private fields */ }

A reference to a Python object.

Note that a PyRef<T> can only deref to a shared / immutable reference. It is the payload type’s responsibility to handle (possibly concurrent) mutability with locks or concurrent data structures if required.

A PyRef<T> can be directly returned from a built-in function to handle situations (such as when implementing in-place methods such as __iadd__) where a reference to the same object must be returned.

Implementations

impl PyRef<PyStr>

pub fn concat_in_place(&mut self, other: &str, vm: &VirtualMachine)

impl PyRef<PyTraceback>

pub fn iter(&self) -> impl Iterator<Item = PyRef<PyTraceback>>

impl<T: PyObjectPayload> PyRef<T>

pub fn new_ref(payload: T, typ: PyTypeRef, dict: Option<PyDictRef>) -> Self

pub fn leak(pyref: Self) -> &'static Py<T>

impl<T: PyPayload> PyRef<T>

pub fn into_exact_or( self, ctx: &Context, f: impl FnOnce(Self) -> PyRefExact<T> ) -> PyRefExact<T>

impl PyRef<VecBuffer>

pub fn into_pybuffer(self, readonly: bool) -> PyBuffer

pub fn into_pybuffer_with_descriptor(self, desc: BufferDescriptor) -> PyBuffer

Methods from Deref<Target = Py<T>>

pub fn to_attributes( &self, vm: &VirtualMachine ) -> IndexMap<&'static PyStrInterned, PyObjectRef, RandomState>

Take a python dictionary and convert it to attributes.

pub fn get_item_opt<K: DictKey + ?Sized>( &self, key: &K, vm: &VirtualMachine ) -> PyResult<Option<PyObjectRef>>

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

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

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

pub fn get_chain<K: DictKey + ?Sized>( &self, other: &Self, key: &K, vm: &VirtualMachine ) -> PyResult<Option<PyObjectRef>>

pub fn f_back(&self, vm: &VirtualMachine) -> Option<PyRef<Frame>>

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

pub fn dict(&self) -> PyDictRef

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

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

pub fn fast_issubclass(&self, cls: &impl Borrow<PyObject>) -> bool

Determines if subclass is actually a subclass of cls, this doesn’t call subclasscheck, so only use this if cls is known to have not overridden the base subclasscheck magic method.

pub fn iter_mro( &self ) -> impl Iterator<Item = &Py<PyType>> + DoubleEndedIterator

pub fn iter_base_chain(&self) -> impl Iterator<Item = &Py<PyType>>

pub fn extend_methods( &'static self, method_defs: &'static [PyMethodDef], ctx: &Context )

pub fn run(&self, vm: &VirtualMachine) -> PyResult<ExecutionResult>

pub fn yield_from_target(&self) -> Option<PyObjectRef>

pub fn is_internal_frame(&self) -> bool

pub fn next_external_frame(&self, vm: &VirtualMachine) -> Option<FrameRef>

pub fn build_function(&self, vm: &VirtualMachine) -> PyRef<PyNativeFunction>

pub fn build_method( &self, class: &'static Py<PyType>, vm: &VirtualMachine ) -> PyRef<PyMethodDescriptor>

pub fn upgrade(&self) -> Option<PyObjectRef>

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

Trait Implementations

impl<T> AsRef<Py<T>> for PyRef<T>where T: PyObjectPayload,

fn as_ref(&self) -> &Py<T>

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

impl<T> AsRef<PyObject> for PyRef<T>where T: PyObjectPayload,

fn as_ref(&self) -> &PyObject

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

impl<T> Borrow<Py<T>> for PyRef<T>where T: PyObjectPayload,

fn borrow(&self) -> &Py<T>

Immutably borrows from an owned value.

impl<T> Borrow<PyObject> for PyRef<T>where T: PyObjectPayload,

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value.

impl<T: PyObjectPayload> Clone for PyRef<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PyObjectPayload> Debug for PyRef<T>

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

Formats the value using the given formatter.

impl<T> Deref for PyRef<T>where T: PyObjectPayload,

type Target = Py<T>

The resulting type after dereferencing.

fn deref(&self) -> &Py<T>

Dereferences the value.

impl<T> Display for PyRef<T>where T: PyObjectPayload + Display,

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

Formats the value using the given formatter.

impl<T: PyObjectPayload> Drop for PyRef<T>

fn drop(&mut self)

Executes the destructor for this type.

impl From<PyRef<PyBaseException>> for ArgumentError

fn from(ex: PyBaseExceptionRef) -> Self

Converts to this type from the input type.

impl From<PyRef<PyDict>> for PyMappingProxy

fn from(dict: PyDictRef) -> Self

Converts to this type from the input type.

impl From<PyRef<PyType>> for PyMappingProxy

fn from(dict: PyTypeRef) -> Self

Converts to this type from the input type.

impl<T: PyObjectPayload> From<PyRef<T>> for PyAtomicRef<T>

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

Converts to this type from the input type.

impl<T> From<PyRef<T>> for PyObjectRefwhere T: PyObjectPayload,

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

Converts to this type from the input type.

impl<T: PyObjectPayload> ToPyObject for PyRef<T>

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

impl<T: PyPayload> TransmuteFromObject for PyRef<T>

fn check(vm: &VirtualMachine, obj: &PyObject) -> PyResult<()>

impl<T: PyObjectPayload> Traverse for PyRef<T>

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

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

impl<T> TryFromObject for PyRef<T>where T: PyPayload,

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

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