Enum InsertionOrigin 

pub enum InsertionOrigin {
    Unspecified,
    Typed,
    Composed,
    Pasted,
    Dropped,
    Imported,
    Replayed,
    Programmatic,
    Assistive,
}

Events emitted by a TextDocument.

Subscribe via TextDocument::on_change (callback-based) or poll via TextDocument::poll_events (frame-loop).

These events carry enough information for a UI to do incremental updates — repaint only the affected region, not the entire document. Which channel some text arrived through.

A fact about how the characters reached the document, and nothing more. It says who typed, pasted or dictated nothing at all: an application can only report the channel it was called through, and the inference from a channel to an author is not one any of this can make.

Why the default is Unspecified and not Programmatic

Every insertion method has a plain form and a _with_origin sibling. The plain form reports Unspecified, which means the caller did not say — deliberately not Programmatic, which would assert that the application inserted the text itself. Those are different claims, and a consumer counting them apart is entitled to know which one it has.

The same distinction as an absent field versus a zero: an unspecified origin is missing information, and a wrong one is a wrong fact.

Variants

Unspecified

The caller did not say. The default for every plain insertion method.

Typed

Entered a key at a time.

Composed

Committed by an input method — the multi-keystroke path that produces one character. Kept apart from Typed because a consumer counting keystrokes and one counting characters disagree here, and both are right.

Pasted

Pasted from a clipboard.

Dropped

Dropped in from elsewhere.

Imported

Brought in by a document import.

Replayed

Re-applied by undo or redo.

Hard-coded at those two paths, which never re-enter the insertion API — they snapshot and diff instead — so a replayed edit can never be counted twice under its original origin.

Programmatic

Inserted by the application: a template, an expansion, a substitution.

Assistive

Arrived through an accessibility channel: dictation, a braille display.

Never folded into Typed. Some people write this way, and a record that erased the distinction would be reporting them as something they are not.

Implementations

impl InsertionOrigin

pub const ALL: [InsertionOrigin; 9]

Every variant, for a consumer building a table over them.

pub fn token(self) -> &'static str

A stable lower-case token, for anything that has to write one down.

Spelled out rather than derived from the variant name, so renaming a variant cannot silently change what a consumer persisted.

Trait Implementations

impl Clone for InsertionOrigin

fn clone(&self) -> InsertionOrigin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for InsertionOrigin

impl Debug for InsertionOrigin

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

Formats the value using the given formatter.

impl Default for InsertionOrigin

fn default() -> InsertionOrigin

Returns the “default value” for a type.

impl Eq for InsertionOrigin

impl Hash for InsertionOrigin

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for InsertionOrigin

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InsertionOrigin