Struct intrusive_collections::rbtree::Cursor

pub struct Cursor<'a, A: Adapter>where
    A::LinkOps: RBTreeOps,{ /* private fields */ }

A cursor which provides read-only access to a RBTree.

Implementations

impl<'a, A: Adapter> Cursor<'a, A>where A::LinkOps: RBTreeOps,

pub fn is_null(&self) -> bool

Checks if the cursor is currently pointing to the null object.

pub fn get(&self) -> Option<&'a <A::PointerOps as PointerOps>::Value>

Returns a reference to the object that the cursor is currently pointing to.

This returns None if the cursor is currently pointing to the null object.

pub fn clone_pointer(&self) -> Option<<A::PointerOps as PointerOps>::Pointer>where <A::PointerOps as PointerOps>::Pointer: Clone,

Clones and returns the pointer that points to the element that the cursor is referencing.

This returns None if the cursor is currently pointing to the null object.

pub fn move_next(&mut self)

Moves the cursor to the next element of the RBTree.

If the cursor is pointer to the null object then this will move it to the first element of the RBTree. If it is pointing to the last element of the RBTree then this will move it to the null object.

pub fn move_prev(&mut self)

Moves the cursor to the previous element of the RBTree.

If the cursor is pointer to the null object then this will move it to the last element of the RBTree. If it is pointing to the first element of the RBTree then this will move it to the null object.

pub fn peek_next(&self) -> Cursor<'_, A>

Returns a cursor pointing to the next element of the RBTree.

If the cursor is pointer to the null object then this will return the first element of the RBTree. If it is pointing to the last element of the RBTree then this will return a null cursor.

pub fn peek_prev(&self) -> Cursor<'_, A>

Returns a cursor pointing to the previous element of the RBTree.

If the cursor is pointer to the null object then this will return the last element of the RBTree. If it is pointing to the first element of the RBTree then this will return a null cursor.

Trait Implementations

impl<'a, A: Adapter> Clone for Cursor<'a, A>where A::LinkOps: RBTreeOps,

fn clone(&self) -> Cursor<'a, A>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.