Home Original page

Cursor in std::collections::btree_set - Rust

pub struct Cursor<'a, K>
where
    K: 'a,
{ /* private fields */ }

🔬This is a nightly-only experimental API. (btree_cursors #107540)

Expand description

A cursor over a BTreeSet.

A Cursor is like an iterator, except that it can freely seek back-and-forth.

Cursors always point to a gap between two elements in the set, and can operate on the two immediately adjacent elements.

A Cursor is created with the BTreeSet::lower_bound and BTreeSet::upper_bound methods.

Source§
Source

🔬This is a nightly-only experimental API. (btree_cursors #107540)

Advances the cursor to the next gap, returning the element that it moved over.

If the cursor is already at the end of the set then None is returned and the cursor is not moved.

Source

🔬This is a nightly-only experimental API. (btree_cursors #107540)

Advances the cursor to the previous gap, returning the element that it moved over.

If the cursor is already at the start of the set then None is returned and the cursor is not moved.

Source

🔬This is a nightly-only experimental API. (btree_cursors #107540)

Returns a reference to next element without moving the cursor.

If the cursor is at the end of the set then None is returned

Source

🔬This is a nightly-only experimental API. (btree_cursors #107540)

Returns a reference to the previous element without moving the cursor.

If the cursor is at the start of the set then None is returned.