Struct scale_info::prelude::collections::linked_list::Cursor
source · [−]pub struct Cursor<'a, T> where
T: 'a, { /* private fields */ }
linked_list_cursors
)Expand description
A cursor over a LinkedList
.
A Cursor
is like an iterator, except that it can freely seek back-and-forth.
Cursors always rest between two elements in the list, and index in a logically circular way.
To accommodate this, there is a “ghost” non-element that yields None
between the head and
tail of the list.
When created, cursors start at the front of the list, or the “ghost” non-element if the list is empty.
Implementations
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Returns the cursor position index within the LinkedList
.
This returns None
if the cursor is currently pointing to the
“ghost” non-element.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Moves the cursor to the next element of the LinkedList
.
If the cursor is pointing to the “ghost” non-element then this will move it to
the first element of the LinkedList
. If it is pointing to the last
element of the LinkedList
then this will move it to the “ghost” non-element.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Moves the cursor to the previous element of the LinkedList
.
If the cursor is pointing to the “ghost” non-element then this will move it to
the last element of the LinkedList
. If it is pointing to the first
element of the LinkedList
then this will move it to the “ghost” non-element.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Returns a reference to the element that the cursor is currently pointing to.
This returns None
if the cursor is currently pointing to the
“ghost” non-element.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Returns a reference to the next element.
If the cursor is pointing to the “ghost” non-element then this returns
the first element of the LinkedList
. If it is pointing to the last
element of the LinkedList
then this returns None
.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Returns a reference to the previous element.
If the cursor is pointing to the “ghost” non-element then this returns
the last element of the LinkedList
. If it is pointing to the first
element of the LinkedList
then this returns None
.
🔬 This is a nightly-only experimental API. (linked_list_cursors
)
linked_list_cursors
)Provides a reference to the front element of the cursor’s parent list, or None if the list is empty.
Trait Implementations
Auto Trait Implementations
impl<'a, T> RefUnwindSafe for Cursor<'a, T> where
T: RefUnwindSafe,
impl<'a, T> UnwindSafe for Cursor<'a, T> where
T: RefUnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Causes self
to use its Binary
implementation when Debug
-formatted.
Causes self
to use its Display
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerExp
implementation when
Debug
-formatted. Read more
Causes self
to use its LowerHex
implementation when
Debug
-formatted. Read more
Causes self
to use its Octal
implementation when Debug
-formatted.
Causes self
to use its Pointer
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperExp
implementation when
Debug
-formatted. Read more
Causes self
to use its UpperHex
implementation when
Debug
-formatted. Read more
Pipes by value. This is generally the method you want to use. Read more
Borrows self
and passes that borrow into the pipe function. Read more
Mutably borrows self
and passes that borrow into the pipe function. Read more
Borrows self
, then passes self.borrow()
into the pipe function. Read more
Mutably borrows self
, then passes self.borrow_mut()
into the pipe
function. Read more
Borrows self
, then passes self.as_ref()
into the pipe function.
Mutably borrows self
, then passes self.as_mut()
into the pipe
function. Read more
Borrows self
, then passes self.deref()
into the pipe function.
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
fn pipe_as_ref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: AsRef<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
fn pipe_borrow<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R where
Self: Borrow<T>,
T: 'a,
R: 'a,
Pipes a trait borrow into a function that cannot normally be called in suffix position. Read more
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
fn pipe_deref<'a, R>(&'a self, func: impl FnOnce(&'a Self::Target) -> R) -> R where
Self: Deref,
R: 'a,
Pipes a dereference into a function that cannot normally be called in suffix position. Read more
Pipes a reference into a function that cannot ordinarily be called in suffix position. Read more
Immutable access to the Borrow<B>
of a value. Read more
Mutable access to the BorrowMut<B>
of a value. Read more
Immutable access to the AsRef<R>
view of a value. Read more
Mutable access to the AsMut<R>
view of a value. Read more
Immutable access to the Deref::Target
of a value. Read more
Mutable access to the Deref::Target
of a value. Read more
Calls .tap()
only in debug builds, and is erased in release builds.
Calls .tap_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_borrow_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_ref_mut()
only in debug builds, and is erased in release
builds. Read more
Calls .tap_deref()
only in debug builds, and is erased in release
builds. Read more
Provides immutable access to the reference for inspection.
Calls tap_ref
in debug builds, and does nothing in release builds.
Provides mutable access to the reference for modification.
Calls tap_ref_mut
in debug builds, and does nothing in release builds.
Provides immutable access to the borrow for inspection. Read more
Calls tap_borrow
in debug builds, and does nothing in release builds.
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
fn tap_borrow_mut<F, R>(self, func: F) -> Self where
Self: BorrowMut<T>,
F: FnOnce(&mut T) -> R,
Provides mutable access to the borrow for modification.
Immutably dereferences self
for inspection.
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
fn tap_deref_dbg<F, R>(self, func: F) -> Self where
Self: Deref,
F: FnOnce(&Self::Target) -> R,
Calls tap_deref
in debug builds, and does nothing in release builds.
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
fn tap_deref_mut<F, R>(self, func: F) -> Self where
Self: DerefMut,
F: FnOnce(&mut Self::Target) -> R,
Mutably dereferences self
for modification.