Struct PyClassTraverseGuard 

pub(crate) struct PyClassTraverseGuard<'a, T: PyClass> {
    value: NonNull<T>,
    borrow_checker: &'a <T::PyClassMutability as PyClassMutability>::Checker,
    phantom: PhantomData<PyBorrowedUnbound<'a, T>>,
}

Variant of crate::PyClassGuard that is used during __traverse__ calls to ensure that only gc-safe operations are performed on the class instance.

Fields

value: NonNull<T>

borrow_checker: &'a <T::PyClassMutability as PyClassMutability>::Checker

phantom: PhantomData<PyBorrowedUnbound<'a, T>>

Implementations

impl<'a, T: PyClass> PyClassTraverseGuard<'a, T>

pub(crate) fn try_from_class_object( class_object: PyBorrowedUnbound<'a, T>, ) -> Option<Self>

Attempts to create a PyClassTraverseGuard from a raw pointer to a class object.

If the Rust state cannot be safely traversed (e.g. unsendable or currently borrowed), this returns None. This will lead to an incomplete traversal, which is safe but may leak memory.

Trait Implementations

impl<'a, T: PyClass> Deref for PyClassTraverseGuard<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: PyClass> Drop for PyClassTraverseGuard<'a, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.