Struct ModeChanged 

pub struct ModeChanged {
    pub from: String,
    pub to: String,
    /* private fields */
}

Editor mode changed.

Emitted after a mode transition occurs (e.g., Normal → Insert). The mode strings are intentionally generic - policy (specific modes) is defined by the runtime and modules.

Type-Safe Mode Transitions

When target_mode is set, it provides the exact ModeId to transition to. This enables event-driven mode transitions without hardcoding command names in the runner layer.

Example

// Commands emit with target_mode for type-safe transitions
ctx.event_bus.emit(ModeChanged::with_mode_id("normal", editor_visual_mode));

// Runner subscribes and updates mode_stack from the event
bus.subscribe::<ModeChanged, _>(priority::CORE, |event| {
    if let Some(mode_id) = event.target_mode() {
        app.mode_stack.set(mode_id.clone());
    }
    EventResult::Handled
});

Fields

from: String

Previous mode description (for display/logging).

to: String

New mode description (for display/logging).

Implementations

impl ModeChanged

pub fn new(from: impl Into<String>, to: impl Into<String>) -> Self

Create a new mode change event with string descriptions only.

Use this for backward compatibility or when the target mode is implicit (e.g., commands that emit events for logging only).

pub fn with_mode_id(from: impl Into<String>, target: ModeId) -> Self

Create a mode change event with a specific target mode ID.

The runner subscribes to these events and updates the mode stack using the provided ModeId, eliminating the need for hardcoded command name mappings.

pub const fn target_mode(&self) -> Option<&ModeId>

Get the target mode ID, if set.

Returns Some(&ModeId) when the event was created with with_mode_id(), None for legacy events created with just string descriptions.

pub const fn has_target_mode(&self) -> bool

Check if this event has a type-safe target mode.

Trait Implementations

impl Clone for ModeChanged

fn clone(&self) -> ModeChanged

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModeChanged

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

Formats the value using the given formatter.

impl Event for ModeChanged

fn priority(&self) -> u32

Priority for handler dispatch ordering.

fn batchable(&self) -> bool

Whether this event can be batched with similar events.

impl PartialEq for ModeChanged

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ModeChanged

impl StructuralPartialEq for ModeChanged