Struct History 

pub struct History {

    pub curhist: i64,
    pub histlinect: i64,
    pub histsiz: i64,
    pub savehistsiz: i64,
    pub histactive: u32,
    pub stophist: i32,
    pub histdone: i32,
    pub hist_skip_flags: i32,
    pub hist_ignore_all_dups: bool,
    pub curline: Option<HistEntry>,
    pub hsubl: Option<String>,
    pub hsubr: Option<String>,
    pub bangchar: char,
    pub histfile: Option<String>,
    /* private fields */
}

History state

Fields

curhist: i64

Current history number

histlinect: i64

History line count

histsiz: i64

History size limit

savehistsiz: i64

Save history size

histactive: u32

History active state

stophist: i32

Stop history flag

histdone: i32

History done flags

hist_skip_flags: i32

History skip flags

hist_ignore_all_dups: bool

Ignore all dups

curline: Option<HistEntry>

Current line being edited

hsubl: Option<String>

History substitution patterns

hsubr: Option<String>

bangchar: char

Bang character

histfile: Option<String>

History file path

Implementations

impl History

pub fn new() -> Self

pub fn init(&mut self)

Initialize history

pub fn hbegin(&mut self, interactive: bool)

Begin history for a new command

pub fn hend(&mut self, text: Option<String>) -> bool

End history for current command

pub fn get(&self, num: i64) -> Option<&HistEntry>

Get entry by history number

pub fn latest(&self) -> Option<&HistEntry>

Get the most recent entry

pub fn recent(&self, n: usize) -> Option<&HistEntry>

Get the n-th most recent entry (0 = latest)

pub fn search_back(&self, pattern: &str, start: i64) -> Option<&HistEntry>

Search history backwards for a pattern

pub fn search_forward(&self, pattern: &str, start: i64) -> Option<&HistEntry>

Search history forwards for a pattern

pub fn expand(&mut self, line: &str) -> Result<String, String>

Perform history substitution

pub fn read_file(&mut self, path: &Path) -> Result<()>

Read history file

pub fn write_file(&self, path: &Path, append: bool) -> Result<()>

Write history file

pub fn clear(&mut self)

Clear all history

pub fn all_entries(&self) -> Vec<&HistEntry>

Get all entries in order

pub fn len(&self) -> usize

Number of entries

pub fn is_empty(&self) -> bool

Check if empty

impl History

History search containing pattern (from hist.c hconsearch lines 1836-1854)

pub fn hconsearch(&self, pattern: &str) -> Option<(i64, usize)>

pub fn hcomsearch(&self, prefix: &str) -> Option<i64>

History search by prefix (from hist.c hcomsearch lines 1859-1872)

pub fn getargs(&self, ev: i64, arg1: usize, arg2: usize) -> Option<String>

Get arguments from history entry (from hist.c getargs lines 2453-2482)

pub fn save_context(&self) -> HistStack

Save history context (from hist.c hist_context_save lines 248-290)

pub fn restore_context(&mut self, ctx: &HistStack)

Restore history context (from hist.c hist_context_restore lines 296-325)

pub fn hist_in_word(&mut self, yesno: bool)

Set history in-word state (from hist.c hist_in_word lines 339-345)

pub fn hist_is_in_word(&self) -> bool

Check if in word (from hist.c hist_is_in_word lines 348-352)

pub fn addhistnum(&self, hl: i64, n: i64) -> i64

Add history number with offset (from hist.c addhistnum lines 1265-1280)

pub fn histreduceblanks(line: &str, words: &[(usize, usize)]) -> String

Reduce blanks in history line (from hist.c histreduceblanks lines 1199-1250)

pub fn resizehistents(&mut self)

Resize history entries to fit histsiz (from hist.c resizehistents lines 2620-2632)

pub fn readhistfile(&mut self, filename: &str, err: bool) -> Result<usize>

Read history file (from hist.c readhistfile lines 2675-2920)

pub fn savehistfile(&self, filename: &str, mode: WriteMode) -> Result<usize>

Write history file (from hist.c savehistfile lines 2925-3155)

pub fn lockhistfile(&self, filename: &str, _excl: bool) -> Result<()>

Lock history file (from hist.c lockhistfile lines 2961-2998)

pub fn unlockhistfile(&self, filename: &str) -> Result<()>

Unlock history file (from hist.c unlockhistfile lines 3001-3018)

pub fn quotestring(s: &str) -> String

Quote string for history (from hist.c quotestring lines 2483-2523)

pub fn get_history_word(line: &str, idx: usize) -> Option<&str>

History word split (from hist.c get_history_word)

pub fn histword_count(line: &str) -> usize

Count words in history line

impl History

History entry navigation (from hist.c movehistent/up_histent/down_histent)

pub fn movehistent(&self, start: i64, n: i64) -> Option<&HistEntry>

Move n entries in history (from hist.c movehistent)

pub fn up_histent(&self, current: i64) -> Option<&HistEntry>

Move up one entry (from hist.c up_histent)

pub fn down_histent(&self, current: i64) -> Option<&HistEntry>

Move down one entry (from hist.c down_histent)

pub fn gethistent(&self, ev: i64, near_match: bool) -> Option<&HistEntry>

Get history entry by event number with near-match (from hist.c gethistent)

pub fn prepnexthistent(&mut self) -> i64

Prepare next history entry (from hist.c prepnexthistent)

Trait Implementations

impl Default for History

fn default() -> Self

Returns the “default value” for a type.