Struct MagitCoreMode 

pub struct MagitCoreMode;

Implementations

impl MagitCoreMode

pub fn mode_id() -> ModeId

Trait Implementations

impl Mode for MagitCoreMode

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

The navigation chords live in magit-nav-mode; read-only views get them by implication so nothing changes for them, and an EDITABLE magit view can imply that mode alone without inheriting the bare letters below.

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

RV.2 (2026-08-10): magit-refresh is every magit buffer’s refresh.

Declared once here, on the minor that spans every magit view — which is the same reason gr was bound here rather than per-view. The chord itself now lives on refreshable-view-mode, pulled in by the implies cascade because this returns Some; the handler body is untouched. See docs/dev/architecture/mode-architecture.md §5.5.

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

OA.4b: <Tab> comes from foldable-view-mode now; magit declares only its BODY. The specialisation is real and stays — on a status file line the first press expands the diff so <Tab> and = agree, and everywhere else it is the plain fold toggle.

<S-Tab> is not declared because it never needed to be: magit’s action:magit-cycle-sections body was literally Effect::AppAction(AppEffect::CycleFoldsGlobal), which is what the shared mode’s own action evaluates to. The copy is deleted.

fn refresh_on_open(&self) -> bool

Re-opening a magit buffer re-runs that refresh.

Every magit view’s content is a snapshot of the repository, and synthetic buffers are created once and reused by name — so the mode’s on_activate, which fills the buffer, ran on the first open only. C-x g on an already-open *magit:status* therefore showed the repo as it was when the buffer was first created: commits made since, files staged in a terminal, a branch switch, none of it visible, and nothing on screen saying the view was old. Reported from use, and the failure is quiet by nature — a stale status buffer looks exactly like a current one.

Declared here rather than per-view for the same reason refresh_action is: it is true of every magit buffer (status, log, branch, stash, diff, …), and the copied-set gap this rule prevents is precisely the one where a view is left out and nobody notices.

The body satisfies the self-contained contract: trigger_refresh spawns the git work off-thread and returns no effect, so nothing on this path needs the dispatch outcome — and the refresh costs the actor thread nothing.

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

MG.13: every magit-core chord, registered once at boot.

None of these need per-buffer state — they read the buffer through BufferStoreHandle using ctx.buffer_id, so they are pure functions of the ActionContext. That matters twice over: this mode is a minor active on every magit buffer, so per-activation registration meant N registrations of the same action id with two magit buffers open — last-wins, and the first deactivation unregistering the chord for both.

gr, s and u are the shared actions: gr is bound here, while s/u are bound by magit-status-mode and magit-diff-mode. Either way the handler must exist exactly once, so all three live here and dispatch per-buffer through MagitView. The binding still belongs to whichever mode offers the chord — a buffer whose mode does not bind s never routes one here.

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

MG.13: nothing to do per activation — every chord this mode contributes is registered at boot by action_handlers(). The Guard is empty; it exists only to satisfy the lifecycle contract (a fresh Guard per activation).

type Guard = ActionRegsGuard

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 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 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 keymap(&self) -> Keymap

Keymap chord → command additions / overrides.

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 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 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 conflicts_with(&self) -> &[ModeId]

Modes this one cannot be active alongside.

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 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).