Struct NgxRbTree

pub struct NgxRbTree<T> { /* private fields */ }

A wrapper over a raw ngx_rbtree_t, a red-black tree implementation.

This wrapper is defined in terms of type T that embeds and can be converted from or to the tree nodes.

See https://nginx.org/en/docs/dev/development_guide.html#red_black_tree.

Implementations

impl<T> NgxRbTree<T>

where T: NgxRbTreeEntry,

pub unsafe fn from_ptr<'a>(tree: *const ngx_rbtree_t) -> &'a Self

Creates a tree reference from a pointer to ngx_rbtree_t.

Safety

tree is a valid pointer to ngx_rbtree_t, and T::from_rbtree_node on the tree nodes results in valid pointers to T.

pub unsafe fn from_ptr_mut<'a>(tree: *mut ngx_rbtree_t) -> &'a mut Self

Creates a mutable tree reference from a pointer to ngx_rbtree_t.

Safety

tree is a valid pointer to ngx_rbtree_t, and T::from_rbtree_node on the tree nodes results in valid pointers to T.

pub fn is_empty(&self) -> bool

Returns true if the tree contains no elements.

pub fn insert(&mut self, node: &mut T)

Appends a node to the tree.

pub fn remove(&mut self, node: &mut T)

Removes the specified node from the tree.

pub fn iter(&self) -> NgxRbTreeIter<'_>

Returns an iterator over the nodes of the tree.

pub fn iter_mut(&mut self) -> NgxRbTreeIter<'_>

Returns a mutable iterator over the nodes of the tree.

Trait Implementations

impl<T: Debug> Debug for NgxRbTree<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.