Struct BufferWordsMode 

pub struct BufferWordsMode;

CSM.4 (insert-completion.md §12 first source migration): buffer-words-mode – contributes the buffer-words completion source. Auto-activates on writable buffer kinds (Document) so the popup’s all-sources view shows words scraped from the active buffer’s text. popup_filter_chord = Some('b') ⇒ <C-b> inside completion-popup-mode narrows the popup to buffer-words only.

Placement: lives in lattice-mode::modes::completion alongside CompletionMode. Ideal location would be lattice-completion::modes (the “feature crate owns its mode” rule), but Mode is defined in lattice-mode and the dep direction is lattice-mode → lattice-completion (CSM.1); the Mode impl can’t live in lattice-completion without a cycle. The source struct (BufferWordsSource) stays in lattice-completion::insert where it belongs; only the thin Mode adapter sits here.

Implementations

impl BufferWordsMode

pub fn mode_id() -> ModeId

The canonical id, "buffer-words-mode" — what Mode::id returns. Use it to name this mode without an instance (activation, implies, keymap layers, tests).

Trait Implementations

impl Mode for BufferWordsMode

type Guard = ()

Owned cleanup token returned by Self::on_activate.

fn id(&self) -> ModeId

Canonical identity. Same value every call.

fn kind(&self) -> ModeKind

Major or minor. Read at registration and on every activation call (activate_major on a minor, or vice versa, is ModeActivationError::WrongKind).

fn options(&self) -> OptionOverrideSet

Option overrides this mode contributes. Pure declarative (same return value every call); the host merges these into the buffer’s option-resolution layer stack while the mode is active, at the mode’s layer (later-activated minors win ties), and drops them on deactivation. Build with lattice_config::overrides! { lattice_config::Wrap = true, … }.

fn required_capabilities(&self) -> CapabilitySet

Capabilities the mode requires. Validated at activation; missing capability ⇒ ModeActivationError::MissingCapability, never silent skip.

fn completion_sources(&self) -> Vec<CompletionSourceContribution>

Insert-mode completion sources this mode contributes while active on a buffer. Empty by default; minors that own a completion source (lsp-completion-mode, snippet-completion-mode, buffer-words-mode, tree-sitter-completion-mode, path-completion-mode, plugin sources) override.

fn on_activate(&self, _ctx: ModeContext) -> LifecycleFuture<'_, ()>

Lifecycle. Called once per (buffer, activation) cycle after the registry has applied the declarative contributions. Returns an owned Guard carrying every resource the mode allocated. The dispatcher stashes the Guard until deactivation, at which point dropping it performs cleanup via the Guard’s Drop impl.

fn target_buffer_kind(&self) -> Option<BufferKind>

For major modes, the [BufferKind] this mode is the default major for (H.2, 2026-05-31). ModeRegistry::register indexes this so ModeRegistry::find_major_for_kind can dispatch buffer-creation events to the right major without host-side match BufferKind { ... } blocks.

fn target_language(&self) -> Option<&str>

For major modes, the language this mode is the default major for, by canonical name (Lang::name() — "rust", "org") (OM.1). The peer of target_buffer_kind for the dispatch path [BufferKind::Document] takes: language detection rather than kind dispatch.

fn keymap(&self) -> Keymap

Keymap chord → command additions / overrides.

fn decorations(&self) -> Vec<DecorationProvider>

Decoration providers (gutter / inline / overlay / statusline). Stub — reserved for the WIT plugin path (M.10).

fn gutter_decorations(&self, _ctx: &DecorationCtx<'_>) -> Vec<GutterDecoration>

Gutter sign decorations this mode contributes while active. Called once per pane per frame with a DecorationCtx carrying relevant render-state snapshots (diff sign map, LSP diagnostics arc). Returns per-line GutterDecoration values; the renderer partitions them by variant into the appropriate gutter column. Default: empty (no contribution).

fn action_handlers(&self) -> Vec<ActionHandlerContribution>

Global (buffer-agnostic) action handlers this mode contributes (SN.3c.0). The host walks every registered mode’s action_handlers() once at boot, resolves each action_name → CommandId, registers the handler in the ActionHandlerRegistry, and holds the tokens for the app’s lifetime. Use this for handlers that read the active buffer / cursor / services from the ActionContext at call time and close over no per-buffer state (e.g. snippet expand). Per-buffer, session-scoped handlers register in on_activate instead, so their tokens drop with the Guard. Default: none. See feedback_effect_vocabulary_is_host_boundary.

fn conflicts_with(&self) -> &[ModeId]

Modes this one cannot be active alongside.

fn implies(&self) -> &[ModeId]

Minor modes activating this mode also activates. Used by relative-line-numbers-mode ⇒ line-numbers-mode, and by read-only majors ⇒ read-only-mode.

fn presents_extensions(&self) -> &[&'static str]

File extensions (lowercase, no dot) this major PRESENTS rather than edits — the file is never loaded as text.

fn mirrors_option(&self) -> Option<&'static str>

Declarative mirror hint for “this mode is the on/off switch for a typed option of the same observable state”. Some(canonical_name) ⇒ a host-driven cascade keeps the mode’s active state and the option’s value in sync.

fn invocation_runner(&self) -> Option<ModeId>

Invocation-runner discovery (2026-05-26). Modes that own command-invocation dispatch for their buffer kind (terminal-mode, oil-mode, file-tree-mode, help-mode, …) return their canonical ModeId; the host registers a runner function under that id at boot, and Editor::run_invocation looks it up by walking the active modes on the active pane’s buffer (minors first, then major) before falling back to the central grammar Action gate.

fn refresh_action(&self) -> Option<&'static str>

Which of this mode’s own actions refreshes its view, or None (the default) when the mode backs nothing refreshable (RV.1, 2026-08-10).

fn fold_toggle_action(&self) -> Option<&'static str>

Which of this mode’s actions <Tab> fires, and the declaration that pulls in foldable-view-mode — the shared minor owning the chord.

fn refresh_on_open(&self) -> bool

Should re-opening this view re-run its refresh?

fn activation_policy(&self) -> ActivationPolicy

A minor mode’s default auto-activation policy (MA.1; mode-architecture.md §7.4). The host’s minor-activation resolver reads this for every registered minor when a buffer enters a major mode, and activates those whose policy admits the entered major. The default is ActivationPolicy::Manual — auto-activate nowhere until the mode or the user opts in. Ignored for major modes (a buffer’s major is chosen by the major resolver, not this allowlist).

fn editable_tail(&self) -> Option<EditableTail>

The mode’s editable tail on an otherwise read-only buffer, or None (the default) for a fully read-only / fully writable buffer (AU‑3).