Struct BufferMode 

pub struct BufferMode {
    pub name: String,
    pub read_only: bool,
    pub allow_text_input: bool,
    pub inherit_normal_bindings: bool,
    pub plugin_name: Option<String>,
}

A buffer mode that defines behavior for a type of buffer

Fields

name: String

Name of this mode (e.g., “special”, “diagnostics-list”)

read_only: bool

Whether buffers with this mode are read-only by default

allow_text_input: bool

When true, unbound character keys in a read-only mode are dispatched as PluginAction("mode_text_input:<char>") instead of being silently dropped. This allows plugins to handle inline text editing (e.g. search fields) without registering individual bindings for every character.

inherit_normal_bindings: bool

When true, keys not bound by this mode fall through to the Normal-context bindings (motion, selection, copy, …) instead of being dropped. Lets viewer-style modes skip re-declaring every built-in cursor action.

plugin_name: Option<String>

Name of the plugin that registered this mode (for attribution in keybinding editor)

Implementations

impl BufferMode

pub fn new(name: impl Into<String>) -> Self

Create a new buffer mode

pub fn with_read_only(self, read_only: bool) -> Self

Set whether this mode is read-only by default

pub fn with_plugin_name(self, plugin_name: Option<String>) -> Self

Set the plugin name for attribution

pub fn with_allow_text_input(self, allow: bool) -> Self

Set whether unbound character keys should be dispatched as text input events

pub fn with_inherit_normal_bindings(self, inherit: bool) -> Self

Set whether unbound keys fall through to Normal-context bindings

Trait Implementations

impl Clone for BufferMode

fn clone(&self) -> BufferMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferMode

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

Formats the value using the given formatter.