Struct PyRef 

pub struct PyRef<T> { /* 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 is_empty(&self) -> bool

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

pub fn try_into_utf8(self, vm: &VirtualMachine) -> PyResult<PyRef<PyUtf8Str>>

impl PyRef<PyUtf8Str>

pub fn into_wtf8(self) -> PyStrRef

Convert to PyStrRef. Safe because PyUtf8Str is a subtype of PyStr.

impl PyRef<PyTraceback>

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

impl PyRef<PyTuple<PyObjectRef>>

pub fn try_into_typed<T: PyPayload>( self, vm: &VirtualMachine, ) -> PyResult<PyRef<PyTuple<PyRef<T>>>>

impl<T: PyPayload> PyRef<PyTuple<PyRef<T>>>

pub fn into_untyped(self) -> PyRef<PyTuple>

impl<T: PyPayload> PyRef<T>

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

impl<T: PyPayload + MaybeTraverse + Debug> PyRef<T>

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

impl<T: PySubclass + Debug> PyRef<T>

where T::Base: Debug,

pub fn into_base(self) -> PyRef<T::Base>

Converts this reference to the base type (ownership transfer).

Safety

T and T::Base must have compatible layouts in size_of::<T::Base>() bytes.

pub fn upcast<U: PyPayload + StaticType>(self) -> PyRef<U>

where T: StaticType,

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 downgrade( &self, callback: Option<PyObjectRef>, vm: &VirtualMachine, ) -> PyResult<PyWeakRef<T>>

pub fn payload(&self) -> &T

pub fn to_base(&self) -> &Py<T::Base>

Converts &Py<T> to &Py<T::Base>.

pub fn upcast_ref<U: PyPayload + StaticType>(&self) -> &Py<U>

where T: StaticType,

Converts &Py<T> to &Py<U> where U is an ancestor type.

Trait Implementations

impl<T> AsRef<Py<T>> for PyRef<T>

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: PyPayload,

fn as_ref(&self) -> &PyObject

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

impl AsRef<PyRef<PyInt>> for ArgIndex

fn as_ref(&self) -> &PyIntRef

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

impl<T> Borrow<Py<T>> for PyRef<T>

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

Immutably borrows from an owned value.

impl<T> Borrow<PyObject> for PyRef<T>

where T: PyPayload,

fn borrow(&self) -> &PyObject

Immutably borrows from an owned value.

impl<T> Clone for PyRef<T>

fn clone(&self) -> Self

Returns a duplicate 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>

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: PyPayload + Display,

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

Formats the value using the given formatter.

impl<T> 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<T: PyPayload> From<PyRef<PyTuple<PyRef<T>>>> for PyTupleRef

fn from(tup: PyRef<PyTuple<PyRef<T>>>) -> 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 From<PyRef<PyUtf8Str>> for PyRef<PyStr>

fn from(s: PyRef<PyUtf8Str>) -> Self

Converts to this type from the input type.

impl<T: PyPayload> 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 PyObjectRef

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

Converts to this type from the input type.

impl<T> Hash for PyRef<T>

where T: Hash + PyPayload,

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> PartialEq for PyRef<T>

where T: PartialEq + PyPayload,

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PyPayload> 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!:

fn clear(&mut self, _out: &mut Vec<PyObjectRef>)

Extract all owned child PyObjectRefs for circular reference resolution (tp_clear). Called just before object deallocation to break circular references. Default implementation does nothing.

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.

impl<T> Eq for PyRef<T>

where T: Eq + PyPayload,