Struct Keystroke 

pub struct Keystroke {
    pub change: String,
    pub value: String,
    pub selection_start: i32,
    pub selection_end: i32,
}

A keystroke offered to the keystroke hook.

Fields

change: String

The text being inserted — one character for a typed key, a whole run for a paste, empty for a deletion.

value: String

The field’s text before the change.

selection_start: i32

Where the replaced range starts, as a character index.

Signed, and negative is a real value a script can write: event.selStart is an int32, read back without a clamp. See Keystroke::applied for what an out-of-range index does.

selection_end: i32

Where it ends, as a character index. Signed for the same reason.

Implementations

impl Keystroke

pub fn of(edit: &TextEdit, change: impl Into<String>) -> Keystroke

The payload a field offers its keystroke hook, read off a live edit.

The four fields: the text being inserted, the field’s value before the change, and the selection the change replaces — which is a caret’s position twice over when nothing is selected.

pub fn applied(&self) -> String

The value this keystroke produces: its selection replaced by its change.

A hook that rewrote change — or moved the selection — is answered by applying what it returned rather than what was offered, which is the whole point of handing the payload back.

An out-of-range index yields nothing, not a clamp

The two halves do not agree with each other, and both are reproduced:

• an out-of-range selection_start — negative, or past the end — yields an empty prefix, so the field’s leading text vanishes;
• an out-of-range selection_end yields an empty suffix, which is the same answer a clamp to the end would give.

Clamping the prefix instead would keep text the oracle drops, on an input any /AA /K script can produce in one assignment.

Trait Implementations

impl Clone for Keystroke

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Keystroke

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

Formats the value using the given formatter.

impl Eq for Keystroke

impl PartialEq for Keystroke

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Keystroke