Struct pyo3::pyclass::gc::PyVisit

pub struct PyVisit<'p> {
    pub(crate) visit: visitproc,
    pub(crate) arg: *mut c_void,
    pub(crate) _py: Python<'p>,
}

Object visitor for GC.

Fields

visit: visitproc

arg: *mut c_void

_py: Python<'p>

VisitProc contains a Python instance to ensure that

1. it is cannot be moved out of the traverse() call
2. it cannot be sent to other threads

Implementations

impl<'p> PyVisit<'p>

pub fn call<T>(&self, obj: &T) -> Result<(), PyTraverseError>

where T: AsPyPointer,

Visit obj.

#[doc(hidden)] pub unsafe fn from_raw( visit: visitproc, arg: *mut c_void, py: Python<'p> ) -> Self

Creates the PyVisit from the arguments to tp_traverse

Trait Implementations

impl<'p> Clone for PyVisit<'p>

fn clone(&self) -> PyVisit<'p>

Returns a copy of the value.

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

Performs copy-assignment from source.