Struct rustyline::history::FileHistory

pub struct FileHistory { /* private fields */ }

Current state of the history stored in a file.

Implementations

impl FileHistory

pub fn new() -> Self

Default constructor

pub fn with_config(config: Config) -> Self

Customized constructor with:

• Config::max_history_size(),
• Config::history_ignore_space(),
• Config::history_duplicates().

pub fn iter(&self) -> impl DoubleEndedIterator<Item = &String> + '_

Return a forward iterator.

Trait Implementations

impl Default for FileHistory

fn default() -> FileHistory

Returns the “default value” for a type.

impl History for FileHistory

fn get( &self, index: usize, dir: SearchDirection ) -> Result<Option<SearchResult<'_>>>

Return the history entry at position index, starting from 0.

fn add(&mut self, line: &str) -> Result<bool>

Add a new entry in the history.

fn add_owned(&mut self, line: String) -> Result<bool>

Add a new entry in the history.

fn len(&self) -> usize

Return the number of entries in the history.

fn is_empty(&self) -> bool

Return true if the history has no entry.

fn set_max_len(&mut self, len: usize) -> Result<()>

Set the maximum length for the history. This function can be called even if there is already some history, the function will make sure to retain just the latest len elements if the new history length value is smaller than the amount of items already inside the history.

fn ignore_dups(&mut self, yes: bool) -> Result<()>

Ignore consecutive duplicates

fn ignore_space(&mut self, yes: bool)

Ignore lines which begin with a space or not

fn save(&mut self, path: &Path) -> Result<()>

Save the history in the specified file.

fn append(&mut self, path: &Path) -> Result<()>

Append new entries in the specified file.

fn load(&mut self, path: &Path) -> Result<()>

Load the history from the specified file.

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

Clear in-memory history

fn search( &self, term: &str, start: usize, dir: SearchDirection ) -> Result<Option<SearchResult<'_>>>

Search history (start position inclusive [0, len-1]).

fn starts_with( &self, term: &str, start: usize, dir: SearchDirection ) -> Result<Option<SearchResult<'_>>>

Anchored search

impl Index<usize> for FileHistory

type Output = String

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a FileHistory

type IntoIter = Iter<'a, String>

Which kind of iterator are we turning this into?

type Item = &'a String

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.