Module nt_list::list

A doubly linked list compatible to LIST_ENTRY of the Windows NT API.

To make this list type-safe, nt-list first asks you to declare an empty enum, which then serves as the L type parameter to distinguish different lists. A list element can be part of multiple linked lists by having multiple entry fields in the element structure. You need to declare an empty enum for every entry field of every element structure.

The empty enum is designated as a doubly linked list via:

#[derive(NtList)]
enum MyList {}

Next you define your element structure, adding an NtListEntry field for each doubly linked list you want your element to be part of. A single NtListEntry field can be marked with #[boxed] to make that list own the elements and handle their memory allocation and deallocation:

#[derive(Default, NtListElement)]
#[repr(C)]
struct MyElement {
    #[boxed]
    entry: NtListEntry<Self, MyList>,
    value: i32,
}

You can then manage that list using the safe NtBoxingListHead interface:

moveit! {
    let mut list = NtBoxingListHead::<MyElement, MyList>::new();
}

list.as_mut().push_back(MyElement {
    value: 42,
    ..Default::default()
});
assert!(!list.as_ref().is_empty());

The last link of a LIST_ENTRY doubly linked list points back to the list header. This requires the address of the list header to be stable. Therefore, the list address is pinned on creation by using the moveit crate, and all doubly linked list functions require pinned references.

For non-boxed entries, you can only use the NtListHead interface. It requires elements to be allocated beforehand on a stable address and be valid as long as the list is used. Without owning the elements, the Rust compiler cannot guarantee the validity of them. This is why almost all NtListHead functions are unsafe. Fortunately, NtListHead is usually only necessary when an element is part of multiple lists.

Structs

• Iter
  Iterator over the elements of a doubly linked list.
• IterMut
  Mutable iterator over the elements of a doubly linked list.
• NtBoxingListHeadalloc
  A variant of NtListHead that boxes every element on insertion.
• NtListEntry
  This structure substitutes the LIST_ENTRY structure of the Windows NT API for actual list entries.
• NtListHead
  A doubly linked list header compatible to LIST_ENTRY of the Windows NT API.

Enums

• NtList
  Designates a list as an NT doubly linked list (LIST_ENTRY structure of the Windows NT API).

Derive Macros

• NtList
  Designates an empty enum as a doubly linked list.