Trait Traverse 

pub unsafe trait Traverse {
    // Required method
    fn traverse(&self, traverse_fn: &mut TraverseFn<'_>);

    // Provided method
    fn clear(&mut self, _out: &mut Vec<PyObjectRef>) { ... }
}

Type that need traverse it’s children should impl Traverse (not MaybeTraverse)

Safety

Please carefully read Traverse::traverse() and follow the guideline

Required Methods

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

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

• Make sure that every owned object(Every PyObjectRef/PyRef) is called with traverse_fn at most once. If some field is not called, the worst results is just memory leak, but if some field is called repeatedly, panic and deadlock can happen.

• DO NOT clone a PyObjectRef or PyRef<T> in Traverse::traverse()

Provided Methods

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.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl Traverse for ()

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

impl Traverse for IndexMap<&'static PyStrInterned, PyObjectRef, RandomState>

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse, H: Traverse, I: Traverse, J: Traverse, K: Traverse, L: Traverse> Traverse for (A, B, C, D, E, F, G, H, I, J, K, L)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse, H: Traverse, I: Traverse, J: Traverse, K: Traverse> Traverse for (A, B, C, D, E, F, G, H, I, J, K)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse, H: Traverse, I: Traverse, J: Traverse> Traverse for (A, B, C, D, E, F, G, H, I, J)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse, H: Traverse, I: Traverse> Traverse for (A, B, C, D, E, F, G, H, I)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse, H: Traverse> Traverse for (A, B, C, D, E, F, G, H)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse, G: Traverse> Traverse for (A, B, C, D, E, F, G)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse, F: Traverse> Traverse for (A, B, C, D, E, F)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse, E: Traverse> Traverse for (A, B, C, D, E)

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

impl<A: Traverse, B: Traverse, C: Traverse, D: Traverse> Traverse for (A, B, C, D)

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

impl<A: Traverse, B: Traverse, C: Traverse> Traverse for (A, B, C)

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

impl<A: Traverse, B: Traverse> Traverse for (A, B)

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

impl<A: Traverse> Traverse for (A,)

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

impl<T: Traverse> Traverse for Option<T>

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

impl<T: Traverse> Traverse for PyMutex<T>

Safety: the lock is not held across visiting children to avoid a re-entrant deadlock. In threading builds traversal runs under stop-the-world so no other thread mutates the guarded value while we read it; in single-threaded builds there is no other writer.

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

impl<T: Traverse> Traverse for PyRwLock<T>

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

impl<T> Traverse for Box<[T]>

where T: Traverse,

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

impl<T> Traverse for Vec<T>

where T: Traverse,

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

impl<T> Traverse for [T]

where T: Traverse,

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

Implementors

impl Traverse for ArgBytesLike

impl Traverse for ArgCallable

impl Traverse for ArgContiguousBytesLike

impl Traverse for ArgIndex

impl Traverse for ArgMapping

impl Traverse for ArgMemoryBuffer

impl Traverse for FrameLocals

impl Traverse for FrameLocalsProxy

impl Traverse for FrameObject

impl Traverse for FuncArgs

impl Traverse for LocalsPlus

impl Traverse for Py<Erased>

impl Traverse for PyAsyncGen

impl Traverse for PyAtomicRef<Option<PyObject>>

impl Traverse for PyAtomicRef<PyObject>

impl Traverse for PyAttributeError

impl Traverse for PyBaseException

impl Traverse for PyBaseExceptionGroup

impl Traverse for PyBoundMethod

impl Traverse for PyBuffer

impl Traverse for PyCallableIterator

impl Traverse for PyClassMethod

impl Traverse for PyCoroutine

impl Traverse for PyDict

impl Traverse for PyEnumerate

impl Traverse for PyFilter

impl Traverse for PyFunction

impl Traverse for PyGenerator

impl Traverse for PyGetSet

impl Traverse for PyImportError

impl Traverse for PyList

impl Traverse for PyMap

impl Traverse for PyMapping<'_>

impl Traverse for PyMappingProxy

impl Traverse for PyMemoryError

impl Traverse for PyMemoryView

impl Traverse for PyNameError

impl Traverse for PyNumber<'_>

impl Traverse for PyOSError

impl Traverse for PyObject

impl Traverse for PyObjectCell

impl Traverse for PyObjectRef

impl Traverse for PyProperty

impl Traverse for PySequence<'_>

impl Traverse for PySequenceIterator

impl Traverse for PySet

impl Traverse for PySlice

impl Traverse for PyStackRef

impl Traverse for PyStaticMethod

impl Traverse for PyStopIteration

impl Traverse for PySuper

impl Traverse for PySyntaxError

impl Traverse for PySystemExit

impl Traverse for PyTraceback

impl Traverse for PyTuple

impl Traverse for PyType

impl Traverse for PyUnicodeError

impl Traverse for PyUnion

impl Traverse for PyZip

impl<A: Traverse, B: Traverse> Traverse for Either<A, B>

impl<O: Borrow<PyObject>> Traverse for PyIter<O>

impl<T, Name: ArgName> Traverse for KwArgs<T, Name>

where T: Traverse,

impl<T, Name: ArgName> Traverse for PosArgs<T, Name>

where T: Traverse,

impl<T, O> Traverse for PyIterIter<'_, T, O>

where O: Traverse + Borrow<PyObject>,

impl<T: MaybeTraverse> Traverse for Py<T>

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

impl<T: PyPayload> Traverse for PyAtomicRef<Option<T>>

impl<T: PyPayload> Traverse for PyAtomicRef<T>

impl<T: Traverse> Traverse for ArgIterable<T>

impl<T: Traverse> Traverse for ArgSequence<T>

impl<T: Traverse> Traverse for IterStatus<T>

impl<T: Traverse> Traverse for PositionIterInternal<T>

impl<T: Traverse> Traverse for PyIterReturn<T>

impl<T> Traverse for OptionalArg<T>

where T: Traverse,