Struct User 

pub struct User;

A blank Mode, intended for plugin authors to use

The only key this Mode actually accepts is KeyCode::Esc, in which case it promptly resets to the default Buffer Mode, which is duatmode’s “Normal” by default.

This means that you can compose more complex expressions and accrue them in the User mode. For example, something that I find particularly useful in prose filetypes is the following:

use duat::prelude::*;
setup_duat!(setup);

fn setup() {
    map::<User>("f", "<Esc><A-j>|fold -s -w 80<Enter>")
        .doc("Fold selected lines by whitespace");
}

This is also where Plugin remappings should be done:

use duat::prelude::*;
 
map::<User>("fb", |pa: &mut Pass| {
    mode::set(pa, mode::RunCommands::new_with("frobnificate "));
});

cmd::add("frobnificate", |pa: &mut Pass, buf: Handle| {
    // Do stuff
    Ok(None)
});

Trait Implementations

impl Clone for User

fn clone(&self) -> User

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for User

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

Formats the value using the given formatter.

impl Mode for User

type Widget = Buffer

The Widget that this Mode controls

fn bindings() -> Bindings

A list of all available keybindings for this Mode

fn send_key(&mut self, pa: &mut Pass, _: KeyEvent, _: Handle<Self::Widget>)

Sends a KeyEvent to this Mode

impl Copy for User