Struct modalkit::editing::history::HistoryList

pub struct HistoryList<T> { /* private fields */ }

A navigable collection of historical values.

Implementations

impl<T> HistoryList<T>

pub fn new(init: T, maxlen: usize) -> Self

Create a new history list.

maxlen controls how many items the history list holds besides the current value.

pub fn first(&self) -> &T

Get a reference to the oldest item in the list.

pub fn last(&self) -> &T

Get a reference to the most recent item in the list.

pub fn start(&mut self) -> &T

Move backwards through the history to the oldest item.

pub fn end(&mut self) -> &T

Move forwards through the history to the most recent item.

pub fn clear(&mut self)

Clear all previous and future history, leaving only the current value.

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

Push a new history item into the list at the current position, and remove any future values.

pub fn append(&mut self, item: T)

Fast-forward the history list so that all values are now in the past, and set a new current value.

pub fn select(&mut self, item: T)

where T: PartialEq,

If item is equivalent to the current value, then the current value is moved to the end of the history list, and all previously future values are now in the past.

Otherwise, if item is different from the current value, this behaves exactly like HistoryList::append.

This is useful for allowing users to navigate through historical values, select one, and make it the most recent value.

pub fn current_mut(&mut self) -> &mut T

Get a mutable reference to the value at the current position.

pub fn current(&self) -> &T

Get a reference to the value at the current position.

pub fn past_len(&self) -> usize

Returns the number of historical items preceding the current value.

pub fn future_len(&self) -> usize

Returns the number of historical items following the current value.

pub fn prev(&mut self, count: usize) -> &T

Move backwards through the history list.

pub fn next(&mut self, count: usize) -> &T

Move forwards through the history list.

pub fn navigate(&mut self, dir: MoveDir1D, count: usize) -> &T

Move forwards or backwards through the history list.

pub fn iter(&self) -> HistoryIterator<'_, T>

Iterate over the values within the history list.

impl<T> HistoryList<T>

where T: CursorSearch<Cursor>,

pub fn find( &mut self, needle: &Regex, dir: MoveDir1D, incremental: bool ) -> Option<&T>

Find a matching element in this history list.

impl HistoryList<EditRope>

pub fn recall( &mut self, current: &EditRope, scrollback: &mut ScrollbackState, dir: MoveDir1D, prefixed: bool, count: usize ) -> Option<EditRope>

Handle scrolling through prompt history.

Trait Implementations

impl<T> Adjustable for HistoryList<T>

where T: Adjustable,

fn zero(&mut self)

Zero out the line and column of any contained cursors.

fn adjust(&mut self, adjs: &[CursorAdjustment])

Apply a CursorAdjustment to any applicable cursors.

impl<T: Clone> Clone for HistoryList<T>

fn clone(&self) -> HistoryList<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for HistoryList<T>

where T: Default,

fn default() -> HistoryList<T>

Returns the “default value” for a type.

impl<T, ID> GlobalAdjustable<ID> for HistoryList<T>

where T: GlobalAdjustable<ID>, ID: ApplicationContentId,

fn zero_id(&mut self, id: &ID)

Zero out cursors associated with a given buffer.

fn adjust_id(&mut self, id: &ID, adjs: &[CursorAdjustment])

Adjust cursors associated with a given buffer.