Skip to main content

HistoryEngine

Struct HistoryEngine 

Source
pub struct HistoryEngine { /* private fields */ }
Expand description

SQLite-backed history engine. Replaces the in-memory histent doubly-linked list + histfile flat-file pair from Src/hist.c — same logical history but with FTS5 search, frequency tracking, and per-directory context.

Implementations§

Source§

impl HistoryEngine

Source

pub fn new() -> Result<Self>

new — see implementation.

Source

pub fn in_memory() -> Result<Self>

in_memory — see implementation.

Source

pub fn text_path() -> PathBuf

$ZSHRS_HOME/zshrs_history — flat text mirror, one line per command in zsh extended-history format:

: <unix_ts>:<duration>;<command>

Newlines inside multi-line commands are escaped as the literal two-character sequence \\n (matches setopt EXTENDED_HISTORYzsh/Src/hist.c:gethistent). Every add appends one line; update_last rewrites the trailing line in place when the duration becomes known. The sqlite index at zshrs_history.db is the query-side mirror of this file — they’re kept in lockstep by the writer, and a divergence-repair pass on open re-reads the text file if the sqlite is missing or older.

Source

pub fn add(&self, command: &str, cwd: Option<&str>) -> Result<i64>

Add a command to history, updating frequency if it already exists

Source

pub fn update_last( &self, id: i64, duration_ms: i64, exit_code: i32, ) -> Result<()>

Update the duration and exit code of the last command

Source

pub fn search(&self, query: &str, limit: usize) -> Result<Vec<HistoryEntry>>

Search history with FTS5 (fuzzy/substring matching)

Source

pub fn search_prefix( &self, prefix: &str, limit: usize, ) -> Result<Vec<HistoryEntry>>

Search history with prefix matching (for up-arrow completion)

Source

pub fn search_prefix_cs( &self, prefix: &str, limit: usize, ) -> Result<Vec<HistoryEntry>>

Case-SENSITIVE prefix probe for the per-keystroke ZLE paths (autosuggest, up-arrow search). Uses GLOB, which is case-sensitive and therefore eligible for the SQLite prefix optimization over idx_history_command (BINARY collation). search_prefix’s LIKE is case-insensitive by default and CANNOT use that index — at 500k+ rows it full-scans, which is far too slow to run on every keystroke.

Source

pub fn recent(&self, limit: usize) -> Result<Vec<HistoryEntry>>

Get recent history entries

Source

pub fn for_directory( &self, cwd: &str, limit: usize, ) -> Result<Vec<HistoryEntry>>

Get history for a specific directory

Source

pub fn delete(&self, id: i64) -> Result<()>

Delete a history entry

Source

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

Clear all history

Source

pub fn count(&self) -> Result<i64>

Get total history count

Source

pub fn get_by_offset(&self, offset: usize) -> Result<Option<HistoryEntry>>

Get entry by index from end (0 = most recent, like !-1)

Source

pub fn get_by_number(&self, num: i64) -> Result<Option<HistoryEntry>>

Get entry by absolute history number (like !123)

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

Source§

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The type for metadata in pointers and references to Self.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more