Struct rustpython_vm::pyobject::PyRef

pub struct PyRef<T> { /* fields omitted */ }

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.

Methods

impl<T: PyValue> PyRef<T>

pub fn as_object(&self) -> &PyObjectRef

pub fn into_object(self) -> PyObjectRef

pub fn typ(&self) -> PyClassRef

Trait Implementations

impl<T> 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: Debug> 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: PyValue, 

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

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

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

Formats the value using the given formatter.

impl<'a, T: PyValue> From<&'a PyRef<T>> for &'a PyObjectRef

fn from(obj: &'a PyRef<T>) -> Self

Performs the conversion.

impl From<PyRef<PyBaseException>> for ArgumentError

fn from(ex: PyBaseExceptionRef) -> Self

Performs the conversion.

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

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

Performs the conversion.

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

fn get_id(&self) -> usize

fn is<T>(&self, other: &T) -> bool where
    T: IdProtocol, 

impl<T> IntoPyObject for PyRef<T>

fn into_pyobject(self, _vm: &VirtualMachine) -> PyResult

impl<T> PyClassDef for PyRef<T> where
    T: PyClassDef, 

const NAME: &'static str

const DOC: Option<&'static str>

impl PyClassImpl for PyRef<Frame>

const TP_FLAGS: PyTpFlags

fn impl_extend_class(ctx: &PyContext, class: &PyClassRef)

fn extend_class(ctx: &PyContext, class: &PyClassRef)

fn make_class(ctx: &PyContext) -> PyClassRef

fn make_class_with_base(ctx: &PyContext, base: PyClassRef) -> PyClassRef

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

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

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

impl<T> TryIntoRef<T> for PyRef<T>

fn try_into_ref(self, _vm: &VirtualMachine) -> PyResult<PyRef<T>>

impl<T> TypeProtocol for PyRef<T>

fn class(&self) -> PyClassRef