Struct scale_info::prelude::collections::btree_map::CursorMutKey

source ·
pub struct CursorMutKey<'a, K, V, A = Global>
where K: 'a, V: 'a,
{ /* private fields */ }
🔬This is a nightly-only experimental API. (btree_cursors)
Expand description

A cursor over a BTreeMap with editing operations, and which allows mutating the key of elements.

A Cursor is like an iterator, except that it can freely seek back-and-forth, and can safely mutate the map during iteration. This is because the lifetime of its yielded references is tied to its own lifetime, instead of just the underlying map. This means cursors cannot yield multiple elements at once.

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

A CursorMutKey is created from a CursorMut with the CursorMut::with_mutable_key method.

§Safety

Since this cursor allows mutating keys, you must ensure that the BTreeMap invariants are maintained. Specifically:

  • The key of the newly inserted element must be unique in the tree.
  • All keys in the tree must remain in sorted order.

Implementations§

source§

impl<'a, K, V, A> CursorMutKey<'a, K, V, A>

source

pub fn next(&mut self) -> Option<(&mut K, &mut V)>

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

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.

source

pub fn prev(&mut self) -> Option<(&mut K, &mut V)>

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

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.

source

pub fn peek_next(&mut self) -> Option<(&mut K, &mut V)>

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

Returns a reference to the key and value of the next element without moving the cursor.

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

source

pub fn peek_prev(&mut self) -> Option<(&mut K, &mut V)>

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

Returns a reference to the key and value of the previous element without moving the cursor.

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

source

pub fn as_cursor(&self) -> Cursor<'_, K, V>

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

Returns a read-only cursor pointing to the same location as the CursorMutKey.

The lifetime of the returned Cursor is bound to that of the CursorMutKey, which means it cannot outlive the CursorMutKey and that the CursorMutKey is frozen for the lifetime of the Cursor.

source§

impl<'a, K, V, A> CursorMutKey<'a, K, V, A>
where K: Ord, A: Allocator + Clone,

source

pub unsafe fn insert_after_unchecked(&mut self, key: K, value: V)

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

Inserts a new key-value pair into the map in the gap that the cursor is currently pointing to.

After the insertion the cursor will be pointing at the gap before the newly inserted element.

§Safety

You must ensure that the BTreeMap invariants are maintained. Specifically:

  • The key of the newly inserted element must be unique in the tree.
  • All keys in the tree must remain in sorted order.
source

pub unsafe fn insert_before_unchecked(&mut self, key: K, value: V)

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

Inserts a new key-value pair into the map in the gap that the cursor is currently pointing to.

After the insertion the cursor will be pointing at the gap after the newly inserted element.

§Safety

You must ensure that the BTreeMap invariants are maintained. Specifically:

  • The key of the newly inserted element must be unique in the tree.
  • All keys in the tree must remain in sorted order.
source

pub fn insert_after( &mut self, key: K, value: V, ) -> Result<(), UnorderedKeyError>

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

Inserts a new key-value pair into the map in the gap that the cursor is currently pointing to.

After the insertion the cursor will be pointing at the gap before the newly inserted element.

If the inserted key is not greater than the key before the cursor (if any), or if it not less than the key after the cursor (if any), then an UnorderedKeyError is returned since this would invalidate the Ord invariant between the keys of the map.

source

pub fn insert_before( &mut self, key: K, value: V, ) -> Result<(), UnorderedKeyError>

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

Inserts a new key-value pair into the map in the gap that the cursor is currently pointing to.

After the insertion the cursor will be pointing at the gap after the newly inserted element.

If the inserted key is not greater than the key before the cursor (if any), or if it not less than the key after the cursor (if any), then an UnorderedKeyError is returned since this would invalidate the Ord invariant between the keys of the map.

source

pub fn remove_next(&mut self) -> Option<(K, V)>

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

Removes the next element from the BTreeMap.

The element that was removed is returned. The cursor position is unchanged (before the removed element).

source

pub fn remove_prev(&mut self) -> Option<(K, V)>

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

Removes the precending element from the BTreeMap.

The element that was removed is returned. The cursor position is unchanged (after the removed element).

Trait Implementations§

source§

impl<K, V, A> Debug for CursorMutKey<'_, K, V, A>
where K: Debug, V: 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, V, A> Freeze for CursorMutKey<'a, K, V, A>

§

impl<'a, K, V, A> RefUnwindSafe for CursorMutKey<'a, K, V, A>

§

impl<'a, K, V, A> Send for CursorMutKey<'a, K, V, A>
where A: Send, K: Send, V: Send,

§

impl<'a, K, V, A> Sync for CursorMutKey<'a, K, V, A>
where A: Sync, K: Sync, V: Sync,

§

impl<'a, K, V, A> Unpin for CursorMutKey<'a, K, V, A>

§

impl<'a, K, V, A = Global> !UnwindSafe for CursorMutKey<'a, K, V, A>

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<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> Conv for T

source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<T> FmtForward for T

source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

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

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> JsonSchemaMaybe for T