Struct History

pub struct History {
    pub buffers: VecDeque<Buffer>,
    pub append_duplicate_entries: bool,
    pub inc_append: bool,
    pub share: bool,
    pub file_size: u64,
    pub load_duplicates: bool,
    /* private fields */
}

Structure encapsulating command history

Fields

buffers: VecDeque<Buffer>

Vector of buffers to store history in

append_duplicate_entries: bool

inc_append: bool

Append each entry to history file as entered?

share: bool

Share history across ion’s with the same history file (combine with inc_append).

file_size: u64

Last filesize of history file, used to optimize history sharing.

load_duplicates: bool

Allow loading duplicate entries, need to know this for loading history files.

Implementations

impl History

pub fn new() -> History

Create new History structure.

pub fn clear_history(&mut self)

Clears out the history.

pub fn load_history(&mut self, append: bool) -> Result<u64>

Loads the history file from the saved path and appends it to the end of the history if append is true otherwise replace history.

pub fn load_history_file<P: AsRef<Path>>( &mut self, path: P, append: bool, ) -> Result<u64>

Loads the history file from path and appends it to the end of the history if append is true.

pub fn set_file_name_and_load_history<P: AsRef<Path>>( &mut self, path: P, ) -> Result<u64>

Set history file name and at the same time load the history.

pub fn set_max_buffers_size(&mut self, size: usize)

Set maximal number of buffers stored in memory

pub fn set_max_file_size(&mut self, size: usize)

Set maximal number of entries in history file

pub fn len(&self) -> usize

Number of items in history.

pub fn is_empty(&self) -> bool

Is the history empty

pub 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.

pub fn remove_duplicates(&mut self, input: &str)

Removes duplicate entries in the history

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

Go through the history and try to find an index (newest to oldest) which starts the same as the new buffer given to this function as argument. Starts at curr_position. Does no wrap.

pub fn get_history_subset(&self, search_term: &Buffer) -> Vec<usize>

pub fn search_index(&self, search_term: &Buffer) -> Vec<usize>

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

Get the history file name.

pub fn commit_to_file_path<P: AsRef<Path>>(&mut self, path: P) -> Result<String>

pub fn commit_to_file(&mut self)

Trait Implementations

impl Default for History

fn default() -> Self

Returns the “default value” for a type.

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.

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.