Struct reedline::SqliteBackedHistory

pub struct SqliteBackedHistory { /* private fields */ }

A history that stores the values to an SQLite database. In addition to storing the command, the history can store an additional arbitrary HistoryEntryContext, to add information such as a timestamp, running directory, result…

Required feature:

sqlite or sqlite-dynlib

Implementations

impl SqliteBackedHistory

pub fn with_file( file: PathBuf, session: Option<HistorySessionId>, session_timestamp: Option<DateTime<Utc>> ) -> Result<Self>

Creates a new history with an associated history file.

Side effects: creates all nested directories to the file

pub fn in_memory() -> Result<Self>

Creates a new history in memory

Trait Implementations

impl History for SqliteBackedHistory

fn save(&mut self, entry: HistoryItem) -> Result<HistoryItem>

save a history item to the database if given id is None, a new id is created and set in the return value if given id is Some, the existing entry is updated

fn load(&self, id: HistoryItemId) -> Result<HistoryItem>

load a history item by its id

fn count(&self, query: SearchQuery) -> Result<i64>

retrieves the next unused session id count the results of a query

fn search(&self, query: SearchQuery) -> Result<Vec<HistoryItem>>

return the results of a query

fn update( &mut self, id: HistoryItemId, updater: &dyn Fn(HistoryItem) -> HistoryItem ) -> Result<()>

update an item atomically

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

delete all history items

fn delete(&mut self, h: HistoryItemId) -> Result<()>

remove an item from this history

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

ensure that this history is written to disk

fn session(&self) -> Option<HistorySessionId>

get the history session id

fn count_all(&self) -> Result<i64>

return the total number of history items