Struct history_navigation::History

pub struct History<T> {
    pub index: usize,
    // some fields omitted
}

History is a vector with support for go forward and go back

Fields

index: usize

Methods

impl<T> History<T>

pub const fn new() -> History<T>

Creates a new history

pub const fn can_go_backward(&self) -> bool

Returns whether you can go backwards

pub fn can_go_forward(&self) -> bool

Returns whether you can go forwards

pub fn go_forward(&mut self)

Go forward

pub fn go_multi_forward(&mut self, count: usize)

Go count times forward

pub fn go_backward(&mut self)

Go backwards

pub fn go_multi_backward(&mut self, count: usize)

Go count times backwards

pub fn push(&mut self, element: T)

Pushes a new element to history

pub fn pop(&mut self) -> Option<T>

Removes the last element from a vector and returns it, or None if it is empty

pub fn get_current(&self) -> &T

Returns the current element

pub fn len(&self) -> usize

Returns the length of the history

Trait Implementations

impl<T> Index<usize> for History<T>

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for History<T>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.