Struct std::collections::btree_map::Cursor
source · pub struct Cursor<'a, K, V>where
K: 'a,
V: 'a,{ /* private fields */ }
🔬This is a nightly-only experimental API. (
btree_cursors
#107540)Expand description
A cursor over a BTreeMap
.
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 map, and can operate on the two immediately adjacent elements.
A Cursor
is created with the BTreeMap::lower_bound
and BTreeMap::upper_bound
methods.
Implementations§
source§impl<'a, K, V> Cursor<'a, K, V>
impl<'a, K, V> Cursor<'a, K, V>
sourcepub fn next(&mut self) -> Option<(&'a K, &'a V)>
🔬This is a nightly-only experimental API. (btree_cursors
#107540)
pub fn next(&mut self) -> Option<(&'a K, &'a V)>
btree_cursors
#107540)Advances the cursor to the next gap, returning the key and value of the element that it moved over.
If the cursor is already at the end of the map then None
is returned
and the cursor is not moved.
sourcepub fn prev(&mut self) -> Option<(&'a K, &'a V)>
🔬This is a nightly-only experimental API. (btree_cursors
#107540)
pub fn prev(&mut self) -> Option<(&'a K, &'a V)>
btree_cursors
#107540)Advances the cursor to the previous gap, returning the key and value of the element that it moved over.
If the cursor is already at the start of the map then None
is returned
and the cursor is not moved.
Trait Implementations§
Auto Trait Implementations§
impl<'a, K, V> RefUnwindSafe for Cursor<'a, K, V>where
K: RefUnwindSafe,
V: RefUnwindSafe,
impl<'a, K, V> Send for Cursor<'a, K, V>
impl<'a, K, V> Sync for Cursor<'a, K, V>
impl<'a, K, V> Unpin for Cursor<'a, K, V>
impl<'a, K, V> UnwindSafe for Cursor<'a, K, V>where
K: RefUnwindSafe,
V: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more