Struct brane_shr::input::FileHistory

pub struct FileHistory { /* private fields */ }

Defines a history that relates to a particular file.

Will automatically write-back on dropping.

Implementations

impl FileHistory

pub fn new(path: impl Into<PathBuf>) -> Self

Constructor for the FileHistory.

Attempts to read the history from the given path, and writes it back when this struct is dropped (unless Self::forget() is called). To this end, avoid having two FileHistory’s that point to the same file.

Arguments

• path: Points to the location of this history’s file.

Returns

A new FileHistory instance.

Warnings

This function emits warnings using warn!() when it fails to read the file.

pub fn forget(self)

Drops this history without saving it.

Trait Implementations

impl Clone for FileHistory

fn clone(&self) -> FileHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileHistory

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

Formats the value using the given formatter.

impl Drop for FileHistory

fn drop(&mut self)

Executes the destructor for this type.

impl History<String> for FileHistory

fn read(&self, pos: usize) -> Option<String>

This is called with the current position that should be read from history. The pos represents the number of times the Up/Down arrow key has been pressed. This would normally be used as an index to some sort of vector. If the pos does not have an entry, None should be returned.

fn write(&mut self, val: &String)

This is called with the next value you should store in history at the first location. Normally history is implemented as a FIFO queue.