Struct key_node_list::Cursor

pub struct Cursor<'a, K, N, M> { /* fields omitted */ }

A cursor over a KeyNodeList.

Implementations

impl<'a, K, N, M> Cursor<'a, K, N, M>

pub fn is_null(&self) -> bool

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

pub fn key(&self) -> Option<&K>

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

Returns None if the cursor is currently pointing to the null pair.

pub fn front_key(&self) -> Option<&K>

Provides a reference to the front key of the cursor’s parent list, or None if the list is empty.

pub fn back_key(&self) -> Option<&K>

Provides a reference to the back key of the cursor’s parent list, or None if the list is empty.

impl<'a, K, N, M> Cursor<'a, K, N, M> where
    K: Hash + Eq,
    M: Map<K, N>, 

pub fn node(&self) -> Option<&N>

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

Returns None if the cursor is currently pointing to the null pair.

pub fn front_node(&self) -> Option<&N>

Provides a reference to the front node of the cursor’s parent list, or None if the list is empty.

pub fn back_node(&self) -> Option<&N>

Provides a reference to the back node of the cursor’s parent list, or None if the list is empty.

impl<'a, K, N, M> Cursor<'a, K, N, M> where
    K: Hash + Eq,
    N: Node<Key = K>,
    M: Map<K, N>, 

pub fn next_key(&self) -> Option<&K>

Returns a reference to the next key.

If the cursor is pointing to the null pair then this returns the first key of the KeyNodeList. If it is pointing to the last key of the KeyNodeList then this returns None.

pub fn prev_key(&self) -> Option<&K>

Returns a reference to the previous key.

If the cursor is pointing to the null pair then this returns the last key of the KeyNodeList. If it is pointing to the first key of the KeyNodeList then this returns None.

pub fn next_node(&self) -> Option<&N>

Returns a reference to the next node.

If the cursor is pointing to the null pair then this returns the first node of the KeyNodeList. If it is pointing to the last node of the KeyNodeList then this returns None.

pub fn prev_node(&self) -> Option<&N>

Returns a reference to the previous node.

If the cursor is pointing to the null pair then this returns the last node of the KeyNodeList. If it is pointing to the first node of the KeyNodeList then this returns None.

impl<'a, K, N, M> Cursor<'a, K, N, M> where
    K: Hash + Eq + Clone,
    N: Node<Key = K>,
    M: Map<K, N>, 

pub fn move_next(&mut self)

Moves the cursor to the next key-node pair of the KeyNodeList.

If the cursor is pointing to the null pair then this will move it to the first key-node pair of the KeyNodeList. If it is pointing to the last key-node pair of the KeyNodeList then this will move it to the null pair.

pub fn move_prev(&mut self)

Moves the cursor to the previous key-node pair of the KeyNodeList.

If the cursor is pointing to the null pair then this will move it to the last key-node pair of the KeyNodeList. If it is pointing to the first key-node pair of the KeyNodeList then this will move it to the null pair.

Trait Implementations

impl<'a, K: Clone, N: Clone, M: Clone> Clone for Cursor<'a, K, N, M>

fn clone(&self) -> Cursor<'a, K, N, M>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, K, N, M> Debug for Cursor<'a, K, N, M> where
    K: Hash + Eq + Debug,
    N: Node<Key = K> + Debug,
    M: Map<K, N>, 

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

Formats the value using the given formatter.