Struct nvim_oxi_api::opts::SetKeymapOptsBuilder

pub struct SetKeymapOptsBuilder(/* private fields */);

Implementations

impl SetKeymapOptsBuilder

pub fn callback<F>(&mut self, fun: F) -> &mut Self

where F: ToFunction<(), ()>,

A function to call when the mapping is executed.

pub fn desc(&mut self, desc: &str) -> &mut Self

A description for the keymap.

pub fn expr(&mut self, expr: bool) -> &mut Self

Whether the keymap argument is an expression.

pub fn noremap(&mut self, noremap: bool) -> &mut Self

Whether the right-hand side of the mapping shouldn’t be remappable.

pub fn nowait(&mut self, nowait: bool) -> &mut Self

For buffer-local mappings, whether Neovim should wait for more characters to be typed if there’s a global mapping that could also match. See :h map-nowait for more details.

pub fn replace_keycodes(&mut self, replace_keycodes: bool) -> &mut Self

When expr is true, this option can be used to replace the keycodes in the resulting string (see replace_termcodes()).

pub fn script(&mut self, script: bool) -> &mut Self

Whether to remap characters in the right-hand side by expanding the <sid> script tag.

pub fn silent(&mut self, silent: bool) -> &mut Self

Whether the keymap should be silent.

pub fn unique(&mut self, unique: bool) -> &mut Self

If true setting the keymap fill fail if another keymap with the same left-hand side already exists.

pub fn build(&mut self) -> SetKeymapOpts

Trait Implementations

impl Clone for SetKeymapOptsBuilder

fn clone(&self) -> SetKeymapOptsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for SetKeymapOptsBuilder

fn default() -> SetKeymapOptsBuilder

Returns the “default value” for a type.