Struct Cursor

Source

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

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

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.

Implementations§

Source §

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

Source

pub fn next(&mut self) -> Option<&'a K>

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

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

pub fn prev(&mut self) -> Option<&'a K>

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

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

pub fn peek_next(&self) -> Option<&'a K>

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

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

pub fn peek_prev(&self) -> Option<&'a K>

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

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.

Trait Implementations§

Source §

impl<'a, K> Clone for Cursor<'a, K>
where K: Clone + 'a,

Source §

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<K> Debug for Cursor<'_, K>
where K: Debug,

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, K> UnwindSafe for Cursor<'a, K>
where K: RefUnwindSafe,

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<S> AssignWithType for S

Source §

fn assign_with_type<T, IntoT>(&mut self, component: IntoT)
where IntoT: Into<T>, S: Assign<T, IntoT>,

Sets the value of a component by its type. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneDyn for T
where T: Clone,

Source §

fn __clone_dyn(&self, _: DontCallMe) -> *mut ()

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source §

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.

Source §

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.

Source §