Skip to main content

Help

Struct Help 

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

Help widget that renders keybinding entries.

In HelpMode::Short mode, entries are shown inline separated by a bullet character, truncated with an ellipsis if they exceed the available width.

In HelpMode::Full mode, entries are rendered in a vertical list with keys and descriptions in aligned columns.

Implementations§

Source§

impl Help

Source

pub fn new() -> Self

Create a new help widget with no entries.

Source

pub fn from_keymap<A>(map: &KeyMap<A>, active: &[ContextId]) -> Self

Build a help bar from a KeyMap: one entry per labelled binding that wins under active contexts (shadowed bindings are left out), with the chord’s display text as the key and the label as the description. Unlabelled bindings have nothing to say and are skipped.

Entries keep bind order; attach a ranker with Help::register_with_ranker and feed dispatched chords back through Help::record_used with chord.to_string() to reorder by use.

Source

pub fn register_with_ranker( &mut self, ranker: &mut HintRanker, context: HintContext, ) -> Vec<usize>

Register every entry with a HintRanker so the widget can be reordered by learned utility (see Help::apply_ranking).

Each entry becomes one ranker hint whose display cost is the width of "key desc" in columns; the returned ids are in entry order, so callers can feed usage back with HintRanker::record_usage when a shortcut is pressed. Call this once after the entries are final; adding entries afterwards requires registering again.

Source

pub fn hint_id(&self, index: usize) -> Option<usize>

Hint id of the entry at index, once registered with a ranker.

Source

pub fn apply_ranking( &mut self, ranker: &mut HintRanker, context_key: Option<&str>, ) -> Vec<RankingEvidence>

Reorder the entries by the ranker’s current utility ordering.

The ranker decides (expected utility, a value-of-information exploration bonus, display cost, and a hysteresis margin that stops near-ties from flickering); this method only applies the order. Entries the ranker did not rank (for example filtered out by context_key) keep their relative order after the ranked ones. Returns the ranker’s evidence ledger so callers can log why the hints are ordered this way. Does nothing if the entries were never registered or changed since.

Source

pub fn record_used(&self, ranker: &mut HintRanker, key: &str) -> bool

Record that the shortcut labelled key was pressed.

Looks the entry up by its key label, records a use for its hint and returns true when the key belongs to a registered entry. Call it from update() when a bound key fires; the next Help::apply_ranking moves frequently used shortcuts forward.

Source

pub fn record_shown(&self, ranker: &mut HintRanker, except_key: Option<&str>)

Record that the entries were displayed without being used.

Call once per interaction round for every registered entry except the one that was used (except_key); the ranker treats it as negative evidence, so hints nobody acts on drift to the end of the bar.

Source

pub fn entry(self, key: impl Into<String>, desc: impl Into<String>) -> Self

Add an entry to the help widget.

Source

pub fn with_entry(self, entry: HelpEntry) -> Self

Add a pre-built entry.

Source

pub fn with_entries(self, entries: Vec<HelpEntry>) -> Self

Set all entries at once.

Source

pub fn with_mode(self, mode: HelpMode) -> Self

Set the display mode.

Source

pub fn with_separator(self, sep: impl Into<String>) -> Self

Set the separator used between entries in short mode.

Source

pub fn with_ellipsis(self, ellipsis: impl Into<String>) -> Self

Set the ellipsis string.

Source

pub fn with_key_style(self, style: Style) -> Self

Set the style for key text.

Source

pub fn with_desc_style(self, style: Style) -> Self

Set the style for description text.

Source

pub fn with_separator_style(self, style: Style) -> Self

Set the style for separators and ellipsis.

Source

pub fn entries(&self) -> &[HelpEntry]

Get the entries.

Source

pub fn mode(&self) -> HelpMode

Get the current mode.

Source

pub fn toggle_mode(&mut self)

Toggle between short and full mode.

Source

pub fn push_entry(&mut self, entry: HelpEntry)

Add an entry mutably.

Trait Implementations§

Source§

impl Clone for Help

Source§

fn clone(&self) -> Help

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 Help

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Help

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl StatefulWidget for Help

Source§

type State = HelpRenderState

The state type associated with this widget.
Source§

fn render(&self, area: Rect, frame: &mut Frame<'_>, state: &mut HelpRenderState)

Render the widget into the frame, potentially modifying state. Read more
Source§

impl Widget for Help

Source§

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area. Read more
Source§

fn is_essential(&self) -> bool

Whether this widget is essential and should always render. Read more

Auto Trait Implementations§

§

impl Freeze for Help

§

impl RefUnwindSafe for Help

§

impl Send for Help

§

impl Sync for Help

§

impl Unpin for Help

§

impl UnsafeUnpin for Help

§

impl UnwindSafe for Help

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