Skip to main content

InputHistory

Struct InputHistory 

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

A bounded, command-line style entry-recall buffer for TextInput.

This is the shell “type a command, press Enter, later press Up to get it back” facility, deliberately not built on the runtime’s undo HistoryManager: recall is a list of submitted strings with a single recall cursor, whereas undo is a stack of reversible edit commands. The two are complementary — undo walks the edits within one line, recall walks between previously submitted lines.

Semantics match a typical shell with ignoredups:

  • push records a non-empty value, skipping a run of an identical value, evicting the oldest once capacity is exceeded, and ending any recall.
  • recall_older (Up) stores the in-progress draft on first use, then walks toward older entries, stopping at the oldest.
  • recall_newer (Down) walks toward newer entries and, once past the newest, restores the saved draft and ends recall.
  • Editing the value ends recall (the edited text becomes the new draft).

Implementations§

Source§

impl InputHistory

Source

pub fn new(capacity: usize) -> Self

A new empty history retaining up to capacity entries (clamped to at least 1).

Source

pub fn push(&mut self, value: String)

Record a submitted value. Empty values and a value equal to the most recent entry are not stored (ignoredups); the oldest entry is evicted once capacity is exceeded. Either way, any active recall ends.

Source

pub fn recall_older(&mut self, current: &str) -> Option<String>

Recall the previous (older) entry, saving current as the draft on the first step. Returns the entry to display, or None when there is nothing to recall. Stops at the oldest entry.

Source

pub fn recall_newer(&mut self) -> Option<String>

Recall the next (newer) entry. Once past the newest entry, restores the saved draft and ends recall. Returns None when no recall is active.

Source

pub fn entries(&self) -> impl Iterator<Item = &str>

The retained entries, oldest first.

Source

pub fn len(&self) -> usize

Number of retained entries.

Source

pub fn is_empty(&self) -> bool

Whether no entries are retained.

Source

pub fn clear(&mut self)

Drop all entries and end any recall.

Source

pub fn capacity(&self) -> usize

The maximum number of retained entries.

Trait Implementations§

Source§

impl Clone for InputHistory

Source§

fn clone(&self) -> InputHistory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for InputHistory

Source§

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

Formats the value using the given formatter. Read more

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> 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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