Zig 0.17.0-dev (Split by item)

This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig library itself.

popFirst

Remove and return a pointer to the first node in the list.

DoublyLinkedList.popFirst

pub fn popFirst(list: *DoublyLinkedList) ?*Node

File

lib/std/DoublyLinkedList.zig:141

Code

pub fn popFirst(list: *DoublyLinkedList) ?*Node {
    const first = list.first orelse return null;
    list.remove(first);
    return first;
}