Struct Cursor 

pub struct Cursor<C> { /* private fields */ }

A generic cursor structure for navigating and manipulating collections. It maintains a position within the collection and provides methods to move forward, backward, to the head, and to the tail of the collection. It requires the collection to implement the Len trait. The cyclic parameter allows the cursor to cycle through the collection.

Implementations

impl<C: Len> Cursor<C>

pub fn new(contents: C, position: usize, cyclic: bool) -> Self

Constructs a new Cursor with the given contents, an initial position, and a cyclic flag. If the given position is greater than the length of the contents, it sets the position to the last item of the contents. If cyclic is true, the cursor can cycle through the collection.

pub fn contents(&self) -> &C

Returns a reference to the contents.

pub fn contents_mut(&mut self) -> &mut C

Returns a mutable reference to the contents.

pub fn replace_contents(&mut self, contents: C)

Replaces the contents with new contents and adjusts the position if necessary.

pub fn position(&self) -> usize

Returns the current position of the cursor.

pub fn shift(&mut self, backward: usize, forward: usize) -> bool

pub fn backward(&mut self) -> bool

Moves the cursor one position backward, if possible. Returns true if successful. If cyclic is true and the cursor is at the head, it moves to the tail.

pub fn forward(&mut self) -> bool

Moves the cursor one position forward, if possible. Returns true if successful. If cyclic is true and the cursor is at the tail, it moves to the head.

pub fn move_to_head(&mut self)

Moves the cursor to the head (start) of the contents.

pub fn is_head(&self) -> bool

Checks if the cursor is at the head (start) of the contents.

pub fn move_to_tail(&mut self)

Moves the cursor to the tail (end) of the contents.

pub fn is_tail(&self) -> bool

Checks if the cursor is at the tail (end) of the contents.

pub fn move_to(&mut self, position: usize) -> bool

Trait Implementations

impl<C: Clone> Clone for Cursor<C>

fn clone(&self) -> Cursor<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.