Enum CtrlHPolicy 

pub enum CtrlHPolicy {
    Chord,
    Backspace,
}

The resolved rule, consulted per key event.

Variants

Chord

Leave Ctrl+h alone: the chord’s binding fires, and a Backspace key that sends 0x08 cannot delete.

Backspace

Rewrite Ctrl+h to Backspace: the key deletes, and the chord is unreachable (rebind the action if you need it).

Implementations

impl CtrlHPolicy

pub fn resolve(setting: CtrlHSetting, keyboard_enhanced: bool) -> Self

Decide the rule for this session.

keyboard_enhanced is whether the kitty keyboard-enhancement flags were pushed — when they were, the two keys are already distinct and Auto keeps the chord. The explicit settings are unconditional: a user who names one has said what they want the byte to mean, and a rule that quietly did nothing on some terminals would be worse than one that is simply obeyed.

pub fn resolve_with( setting: CtrlHSetting, keyboard_enhanced: bool, tty_erase_is_bs: bool, ) -> Self

Self::resolve with the tty probe supplied rather than performed.

Two callers need this. kimun doctor already knows the erase character and must not read it a second time — it declines to read it at all when its output is redirected, and a hidden probe inside here would contradict the disclaimer it prints. And the Auto branches are only testable at all once the probe is an argument: called for real, it reads the test runner’s own stdin.

pub fn loss_is_worth_reporting(self, setting: CtrlHSetting) -> bool

Whether losing the Ctrl+H chord is worth telling the user about.

Only when they did not ask for it. ctrl_h = "backspace" is a choice made against a documented consequence — the setting’s own documentation says the chord becomes unreachable — so reporting it every launch says nothing they do not know, and a warning that fires on a working, chosen setup is one people learn to ignore. Under auto the erase-character probe can reach the same policy without anyone choosing it, and there it is news.

pub fn apply(self, key: KeyEvent) -> KeyEvent

key, with Ctrl+h rewritten to Backspace when that is the rule.

The modifier test is exact, so Ctrl+Shift+H and Ctrl+Alt+H — chords a terminal spells differently, and which no Backspace key sends — pass through untouched. kind and state are carried over: the rewrite changes which key this is, not whether it is a press.

Trait Implementations

impl Clone for CtrlHPolicy

fn clone(&self) -> CtrlHPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CtrlHPolicy

impl Debug for CtrlHPolicy

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

Formats the value using the given formatter.

impl Default for CtrlHPolicy

fn default() -> CtrlHPolicy

Returns the “default value” for a type.

impl Eq for CtrlHPolicy

impl PartialEq for CtrlHPolicy

fn eq(&self, other: &CtrlHPolicy) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CtrlHPolicy