Struct liner::History

pub struct History {
    pub buffers: VecDeque<Buffer>,
    pub append_duplicate_entries: bool,
    // some fields omitted
}

Structure encapsulating command history

Fields

buffers: VecDeque<Buffer>

Vector of buffers to store history in

append_duplicate_entries: bool

Methods

impl History

fn commit_history(&mut self)

It's important to execute this function before exiting your program, as it will ensure that all history data has been written to the disk.

fn new() -> History

Create new History structure.

fn len(&self) -> usize

Number of items in history.

fn push(&mut self, new_item: Buffer) -> Result<()>

Add a command to the history buffer and remove the oldest commands when the max history size has been met. If writing to the disk is enabled, this function will be used for logging history to the designated history file.

fn get_newest_match<'a, 'b>(
    &'a self,
    curr_position: Option<usize>,
    new_buff: &'b Buffer
) -> Option<&'a Buffer>

Go through the history and try to find a buffer which starts the same as the new buffer given to this function as argument.

fn file_name(&self) -> Option<&str>

Get the history file name.

fn set_file_name(&mut self, name: Option<String>)

Set history file name. At the same time enable history.

fn set_max_size(&mut self, size: usize)

Set maximal number of buffers stored in memory

fn set_max_file_size(&mut self, size: usize)

Set maximal number of entries in history file

fn load_history(&mut self) -> Result<()>

Load history from given file name

Trait Implementations

impl<'a> IntoIterator for &'a History

type Item = &'a Buffer

The type of the elements being iterated over.

type IntoIter = Iter<'a, Buffer>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Index<usize> for History

type Output = Buffer

The returned type after indexing.

fn index(&self, index: usize) -> &Buffer

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for History

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

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