Struct NtBoxingListHead

pub struct NtBoxingListHead<E: NtBoxedListElement<L = L> + NtListElement<L>, L: NtTypedList<T = NtList>>(/* private fields */);

Available on crate feature alloc only.

A variant of NtListHead that boxes every element on insertion.

This guarantees ownership and therefore all NtBoxingListHead functions can be used without resorting to unsafe. If you can, use this implementation over NtListHead.

You need to implement the NtBoxedListElement trait to designate a single list as the boxing one. This also establishes clear ownership when a single element is part of more than one list.

See the module-level documentation for more details.

This structure substitutes the LIST_ENTRY structure of the Windows NT API for the list header.

Implementations

impl<E, L> NtBoxingListHead<E, L>

where E: NtBoxedListElement<L = L> + NtListElement<L>, L: NtTypedList<T = NtList>,

pub fn new() -> impl New<Output = Self>

Creates a new doubly linked list that owns all elements.

This function substitutes InitializeListHead of the Windows NT API.

pub fn append(self: Pin<&mut Self>, other: Pin<&mut Self>)

Moves all elements from other to the end of the list.

This reuses all the nodes from other and moves them into self. After this operation, other becomes empty.

This operation computes in O(1) time.

pub fn back(self: Pin<&Self>) -> Option<&E>

Provides a reference to the last element, or None if the list is empty.

This operation computes in O(1) time.

pub fn back_mut(self: Pin<&mut Self>) -> Option<&mut E>

Provides a mutable reference to the last element, or None if the list is empty.

This operation computes in O(1) time.

pub fn clear(self: Pin<&mut Self>)

Removes all elements from the list, deallocating their memory.

Unlike NtListHead::clear, this operation computes in O(n) time, because it needs to traverse all elements to deallocate them.

pub fn front(self: Pin<&Self>) -> Option<&E>

Provides a reference to the first element, or None if the list is empty.

This operation computes in O(1) time.

pub fn front_mut(self: Pin<&mut Self>) -> Option<&mut E>

Provides a mutable reference to the first element, or None if the list is empty.

This operation computes in O(1) time.

pub fn is_empty(self: Pin<&Self>) -> bool

Returns true if the list is empty.

This function substitutes IsListEmpty of the Windows NT API.

This operation computes in O(1) time.

pub fn iter(self: Pin<&Self>) -> Iter<'_, E, L>

Returns an iterator yielding references to each element of the list.

pub fn iter_mut(self: Pin<&mut Self>) -> IterMut<'_, E, L>

Returns an iterator yielding mutable references to each element of the list.

pub fn len(self: Pin<&Self>) -> usize

Counts all elements and returns the length of the list.

This operation computes in O(n) time.

pub fn pop_back(self: Pin<&mut Self>) -> Option<Box<E>>

Removes the last element from the list and returns it, or None if the list is empty.

This function substitutes RemoveTailList of the Windows NT API.

This operation computes in O(1) time.

pub fn pop_front(self: Pin<&mut Self>) -> Option<Box<E>>

Removes the first element from the list and returns it, or None if the list is empty.

This function substitutes RemoveHeadList of the Windows NT API.

This operation computes in O(1) time.

pub fn push_back(self: Pin<&mut Self>, element: E)

Appends an element to the back of the list.

This function substitutes InsertTailList of the Windows NT API.

This operation computes in O(1) time.

pub fn push_front(self: Pin<&mut Self>, element: E)

Appends an element to the front of the list.

This function substitutes InsertHeadList of the Windows NT API.

This operation computes in O(1) time.

pub fn retain<F>(self: Pin<&mut Self>, f: F)

where F: FnMut(&mut E) -> bool,

Retains only the elements specified by the predicate, passing a mutable reference to it.

In other words, remove all elements e for which f(&mut e) returns false. This method operates in place, visiting each element exactly once in the original order, and preserves the order of the retained elements.

This function substitutes RemoveEntryList of the Windows NT API.

This operation computes in O(n) time.

Trait Implementations

impl<E, L> Drop for NtBoxingListHead<E, L>

where E: NtBoxedListElement<L = L> + NtListElement<L>, L: NtTypedList<T = NtList>,

fn drop(&mut self)

Executes the destructor for this type.

impl<E, L> Extend<Box<E>> for Pin<&mut NtBoxingListHead<E, L>>

where E: NtBoxedListElement<L = L> + NtListElement<L>, L: NtTypedList<T = NtList>,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Box<E>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<E, L> Extend<E> for Pin<&mut NtBoxingListHead<E, L>>

where E: NtBoxedListElement<L = L> + NtListElement<L>, L: NtTypedList<T = NtList>,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = E>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.