Struct reedline::FileBackedHistory

pub struct FileBackedHistory { /* private fields */ }

Stateful history that allows up/down-arrow browsing with an internal cursor.

Can optionally be associated with a newline separated history file using the FileBackedHistory::with_file() constructor. Similar to bash’s behavior without HISTTIMEFORMAT. (See https://www.gnu.org/software/bash/manual/html_node/Bash-History-Facilities.html) If the history is associated to a file all new changes within a given history capacity will be written to disk when History is dropped.

Implementations

impl FileBackedHistory

pub fn new(capacity: usize) -> Self

Creates a new in-memory history that remembers n <= capacity elements

Panics

If capacity == usize::MAX

pub fn with_file(capacity: usize, file: PathBuf) -> Result<Self>

Creates a new history with an associated history file.

History file format: commands separated by new lines. If file exists file will be read otherwise empty file will be created.

Side effects: creates all nested directories to the file

Trait Implementations

impl Debug for FileBackedHistory

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileBackedHistory

fn default() -> Self

Creates an in-memory History with a maximal capacity of HISTORY_SIZE.

To create a History that is synchronized with a file use FileBackedHistory::with_file()

impl Drop for FileBackedHistory

fn drop(&mut self)

On drop the content of the History will be written to the file if specified via FileBackedHistory::with_file().

impl History for FileBackedHistory

fn append(&mut self, entry: &str)

Appends an entry if non-empty and not repetition of the previous entry. Resets the browsing cursor to the default state in front of the most recent entry.

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

Writes unwritten history contents to disk.

If file would exceed capacity truncates the oldest entries.

fn reset_cursor(&mut self)

Reset the internal browsing cursor

fn iter_chronologic(&self) -> Iter<'_, String>

Chronologic interaction over all entries present in the history

fn back(&mut self)

This moves the cursor backwards respecting the navigation query that is set

fn forward(&mut self)

This moves the cursor forwards respecting the navigation-query that is set

fn string_at_cursor(&self) -> Option<String>

Returns the string (if present) at the cursor

fn set_navigation(&mut self, navigation: HistoryNavigationQuery)

Set a new navigation mode for search based on input query defined in HistoryNavigationQuery

fn get_navigation(&self) -> HistoryNavigationQuery

Poll the current HistoryNavigationQuery mode

fn query_entries(&self, search: &str) -> Vec<String>

Query the values in the history entries

fn max_values(&self) -> usize

Max number of values that can be queried from the history