Trait rustpython_common::linked_list::Link

pub unsafe trait Link {
    type Handle;
    type Target;

    fn as_raw(handle: &Self::Handle) -> NonNull<Self::Target>;
    unsafe fn from_raw(ptr: NonNull<Self::Target>) -> Self::Handle;
    unsafe fn pointers(
        target: NonNull<Self::Target>
    ) -> NonNull<Pointers<Self::Target>>;
}

Defines how a type is tracked within a linked list.

In order to support storing a single type within multiple lists, accessing the list pointers is decoupled from the entry type.

Safety

Implementations must guarantee that Target types are pinned in memory. In other words, when a node is inserted, the value will not be moved as long as it is stored in the list.

Required Associated Types

type Handle

Handle to the list entry.

This is usually a pointer-ish type.

type Target

Node type.

Required Methods

fn as_raw(handle: &Self::Handle) -> NonNull<Self::Target>

Convert the handle to a raw pointer without consuming the handle.

unsafe fn from_raw(ptr: NonNull<Self::Target>) -> Self::Handle

Convert the raw pointer to a handle

unsafe fn pointers(
    target: NonNull<Self::Target>
) -> NonNull<Pointers<Self::Target>>

Return the pointers for a node

Implementors