Struct History 

pub struct History { /* private fields */ }

Interface for querying and manipulating the shell’s recorded history of commands.

Implementations

impl History

pub fn import(reader: impl Read) -> Result<Self, Error>

Constructs a new History instance, with its contents initialized from the given readable stream. If errors are encountered reading lines from the stream, unreadable lines will be skipped but the call will still return successfully, with a warning logged. An error result will be returned only if an internal error occurs updating the history.

Arguments

• reader - The readable stream to import history from.

pub fn get_by_id(&self, id: i64) -> Result<Option<&Item>, Error>

Tries to retrieve a history item by its unique identifier. Returns None if no item is found.

Arguments

• id - The unique identifier of the history item to retrieve.

pub fn update_by_id(&mut self, id: i64, item: Item) -> Result<(), Error>

Replaces the history item with the given ID with a new item. Returns an error if the item cannot be updated.

Arguments

• id - The unique identifier of the history item to update.
• item - The new history item to replace the old one.

pub fn remove_nth_item(&mut self, n: usize) -> bool

Removes the nth item from the history. Returns the removed item, or None if no such item exists (i.e., because it was out of range).

pub fn add(&mut self, item: Item) -> Result<i64, Error>

Adds a new history item. Returns the unique identifier of the newly added item.

Arguments

• item - The history item to add.

pub fn delete_item_by_id(&mut self, id: i64) -> Result<(), Error>

Deletes a history item by its unique identifier. Returns an error if the item cannot be deleted.

Arguments

• id - The unique identifier of the history item to delete.

pub fn clear(&mut self) -> Result<(), Error>

Clears all history items.

pub fn flush( &mut self, history_file_path: impl AsRef<Path>, append: bool, unsaved_items_only: bool, write_timestamps: bool, ) -> Result<(), Error>

Flushes the history to backing storage (if relevant).

Arguments

• history_file_path - The path to the history file.
• append - Whether to append to the file or overwrite it.
• unsaved_items_only - Whether to only write unsaved items; if true, any items will be marked as “saved” once saved.
• write_timestamps - Whether to write timestamps for each command line.

pub fn search(&self, query: Query) -> Result<impl Iterator<Item = &Item>, Error>

Searches through history using the given query.

Arguments

• query - The query to use.

pub fn iter(&self) -> impl Iterator<Item = &Item>

Returns an iterator over the history items.

pub fn get(&self, index: usize) -> Option<&Item>

Retrieves the nth history item, if it exists. Returns None if no such item exists. Indexing is zero-based, with an index of 0 referencing the oldest item in the history.

Arguments

• index - The index of the history item to retrieve.

pub fn count(&self) -> usize

Returns the number of items in the history.

Trait Implementations

impl Clone for History

fn clone(&self) -> History

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for History

fn default() -> History

Returns the “default value” for a type.