Struct History 

pub struct History {
    pub limit_size: Option<usize>,
    /* private fields */
}

Available on crate feature texteditor only.

Manages the history of user inputs for a text editor. This structure allows for the storage, retrieval, and navigation through past inputs. It supports adding new entries, checking for the existence of specific entries, and moving through the history in both forward and backward directions. Additionally, it can limit the number of entries stored in the history to a specified maximum size.

Fields

limit_size: Option<usize>

Optional limit on the number of entries in the history. If set, the history will not exceed this number of entries, and older entries will be removed to make room for new ones.

Implementations

impl History

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

Saves the current history items to a file in reverse order (newest first), respecting the optional limit on the number of entries if provided.

Arguments

• path - The path to the file where the history should be saved.

Returns

Returns Ok(()) if the history was successfully saved, or an io::Error otherwise.

pub fn load_from_file<P: AsRef<Path>>( path: P, limit_size: Option<usize>, ) -> Result<Self>

Loads history items from a file into a new History instance.

This function reads the specified file line by line, adding each non-empty line to the history. It respects the optional limit on the number of entries if provided. An empty string is always added at the end of the history to represent a new input line. After loading, the cursor is moved to the end of the history.

Arguments

• path - The path to the file from which the history should be loaded.
• limit_size - An optional limit on the number of entries in the history.

Returns

Returns Ok(History) with the loaded history if successful, or an io::Error otherwise.

pub fn insert<T: AsRef<str>>(&mut self, item: T)

Inserts a new item into the history.

If the item does not already exist in the buffer, it is inserted just before the last item. This method ensures there is always an empty string at the end of the buffer to represent a new input line. After insertion, the current position is moved to the end of the buffer.

Arguments

• item - The item to be inserted into the history.

Examples

• Initial state: items = [""]
• After inserting “abc”: items = ["abc", ""]
• After inserting “xyz”: items = ["abc", "xyz", ""]

pub fn get(&self) -> String

Retrieves the current item from the history based on the current position. Returns an empty string if the position is out of bounds.

pub fn backward(&mut self) -> bool

Moves the current position backward in the history, if possible. Returns true if the position was successfully moved backward, false otherwise.

pub fn forward(&mut self) -> bool

Moves the current position forward in the history, if possible. Returns true if the position was successfully moved forward, false otherwise.

pub fn move_to_tail(&mut self)

Moves the current position to the tail (end) of the history buffer.

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() -> Self

Creates a new History instance with a single empty string in the buffer and initializes the position at 0.