[−][src]Struct rustyline::history::History
Current state of the history.
Methods
impl History
[src]
pub fn new() -> Self
[src]
pub fn with_config(config: Config) -> Self
[src]
pub fn get(&self, index: usize) -> Option<&String>
[src]
Return the history entry at position index
, starting from 0.
pub fn last(&self) -> Option<&String>
[src]
Return the last history entry (i.e. previous command)
pub fn add<S: AsRef<str> + Into<String>>(&mut self, line: S) -> bool
[src]
Add a new entry in the history.
pub fn len(&self) -> usize
[src]
Return the number of entries in the history.
pub fn is_empty(&self) -> bool
[src]
Return true if the history has no entry.
pub fn set_max_len(&mut self, len: usize)
[src]
Set the maximum length for the history. This function can be called even
if there is already some history, the function will make sure to retain
just the latest len
elements if the new history length value is
smaller than the amount of items already inside the history.
Like [stifle_history](http://cnswww.cns.cwru. edu/php/chet/readline/history.html#IDX11).
pub fn save<P: AsRef<Path> + ?Sized>(&self, path: &P) -> Result<()>
[src]
Save the history in the specified file.
pub fn load<P: AsRef<Path> + ?Sized>(&mut self, path: &P) -> Result<()>
[src]
Load the history from the specified file.
Errors
Will return Err
if path does not already exist or could not be read.
pub fn clear(&mut self)
[src]
Clear history
pub fn search(&self, term: &str, start: usize, dir: Direction) -> Option<usize>
[src]
Search history (start position inclusive [0, len-1]).
Return the absolute index of the nearest history entry that matches
term
.
Return None if no entry contains term
between [start, len -1] for
forward search
or between [0, start] for reverse search.
pub fn starts_with(
&self,
term: &str,
start: usize,
dir: Direction
) -> Option<usize>
[src]
&self,
term: &str,
start: usize,
dir: Direction
) -> Option<usize>
Anchored search
ⓘImportant traits for Iter<'a>pub fn iter(&self) -> Iter
[src]
Return a forward iterator.
Trait Implementations
impl Default for History
[src]
impl<'a> IntoIterator for &'a History
[src]
type IntoIter = Iter<'a>
Which kind of iterator are we turning this into?
type Item = &'a String
The type of the elements being iterated over.
ⓘImportant traits for Iter<'a>fn into_iter(self) -> Iter<'a>
[src]
impl Index<usize> for History
[src]
Auto Trait Implementations
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,