Skip to main content

KeymapCapability

Enum KeymapCapability 

Source
pub enum KeymapCapability {
    Full,
    User,
    MinorMode,
    OwnedLayer {
        mode_id: ModeId,
    },
}
Expand description

Privilege bundle a writer presents when calling capability-gated bind APIs (slice 8.h). Mirrors the WIT keymap-write capability variants in DESIGN.md §5.5: the host hands one of these to every caller of the registry – built-in startup, the user’s compiled init.rs, each loaded plugin – and the registry enforces the layer scope before committing any write.

Today the enforcement runs purely in-process (no WASM host has landed yet). When the plugin host is built, the WIT bind / unbind / push-layer / pop-layer host functions translate the caller’s manifest-declared capability into one of these variants and call through try_*.

Variants§

§

Full

Unrestricted: write to any layer. Reserved for the host’s startup pass that registers the built-in catalog.

§

User

Write only to KeymapLayer::User. The compiled init.rs runs with this capability at boot. Mirror of the WIT “user” capability; denies writes to Builtin, MajorMode, MinorMode(_), and Buffer.

§

MinorMode

Write to any KeymapLayer::MinorMode or KeymapLayer::Buffer layer. Plugins receive this when their manifest declares keymap-write:minor-mode – permits transient overlays (custom modes, popup overrides) but denies writes to Builtin / MajorMode / User.

§

OwnedLayer

Write only to a single specified KeymapLayer::MinorMode identified by its ModeId. Mirror of the WIT keymap-write:plugin-layer variant: each subsystem (plugin, user init.rs extending an existing mode) gets a capability scoped to one specific mode’s keymap layer — e.g. OwnedLayer { mode_id: ModeId::new("diff-mode") } authorises writes only to the diff-mode layer.

K.1.b (2026-05-30): re-keyed from opaque LayerId to ModeId so the capability names the mode it targets directly. Matches emacs’s (:map foo-mode-map ...) shape: the binding is scoped to the mode, lives + dies with the mode’s activation lifecycle.

Fields

§mode_id: ModeId

The one mode whose layer (MinorMode(mode_id) or MajorMode(mode_id)) this capability may write.

Trait Implementations§

Source§

impl Clone for KeymapCapability

Source§

fn clone(&self) -> KeymapCapability

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for KeymapCapability

Source§

impl Debug for KeymapCapability

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for KeymapCapability

Source§

impl PartialEq for KeymapCapability

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for KeymapCapability

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more