Struct nvim::api::Api

source · [−]

pub struct Api<'lua> { /* private fields */ }

Expand description

vim.api.* Neovim doc

Implementations

source

impl<'lua> Api<'lua>

source

pub fn nvim__get_runtime(
 &self,
 pat: &[&str ],
 all: bool,
 opts: NvimGetRuntimeOpts
) -> LuaValue<'_>

Neovim doc

source

pub fn nvim_buf_create_user_command(
 &self,
 buffer: Index,
 name: String,
 command: Command<'_>,
 opts: NvimCreateUserCommandOpts
)

Neovim doc

source

pub fn nvim_create_autocmd(
 &self,
 events: Vec<String>,
 opts: NvimCreateAutocmdsOpts<'_>
) -> i64

Create an autocommand

The API allows for two (mutually exclusive) types of actions to be executed when the autocommand triggers: a callback function (Lua or Vimscript), or a command (like regular autocommands).

Neovim doc

source

pub fn nvim_exec(&self, src: &str, output: bool) -> String

Neovim doc

source

pub fn nvim_get_autocmds(&self, opts: NvimGetAutocmdsOpts) -> Vec<AutoCmd>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Get all autocommands that match the corresponding opts.

Neovim doc

source

pub fn nvim_get_runtime_file(&self, glob: &str, all: bool) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Find files in runtime direcories

Neovim doc

source

pub fn nvim_set_keymap(
 &self,
 mode: Mode,
 lhs: &str,
 rhs: &str,
 opts: NvimSetKeymapOpts<'_>
)

Neovim doc

Trait Implementations

source

impl<'lua> FromLua<'lua> for Api<'lua>

source

fn from_lua(lua_value: LuaValue<'lua>, lua: &'lua Lua) -> LuaResult<Self>

Performs the conversion.

Auto Trait Implementations

impl<'lua> !RefUnwindSafe for Api<'lua>

impl<'lua> !Send for Api<'lua>

impl<'lua> !Sync for Api<'lua>

impl<'lua> Unpin for Api<'lua>

impl<'lua> !UnwindSafe for Api<'lua>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<'lua, T> FromLuaMulti<'lua> for T where
T: FromLua<'lua>,

source

fn from_lua_multi(values: MultiValue<'lua>, lua: &'lua Lua) -> Result<T, Error>

Performs the conversion. Read more

source

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

const: unstable · 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, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct nvim::api::Api

Implementations

impl<'lua> Api<'lua>

pub fn nvim__get_runtime(
    &self,
    pat: &[&str ],
    all: bool,
    opts: NvimGetRuntimeOpts
) -> LuaValue<'_>

pub fn nvim_buf_create_user_command(
    &self,
    buffer: Index,
    name: String,
    command: Command<'_>,
    opts: NvimCreateUserCommandOpts
)

pub fn nvim_create_autocmd(
    &self,
    events: Vec<String>,
    opts: NvimCreateAutocmdsOpts<'_>
) -> i64

pub fn nvim_exec(&self, src: &str, output: bool) -> String

pub fn nvim_get_autocmds(&self, opts: NvimGetAutocmdsOpts) -> Vec<AutoCmd>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn nvim_get_runtime_file(&self, glob: &str, all: bool) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn nvim_set_keymap(
    &self,
    mode: Mode,
    lhs: &str,
    rhs: &str,
    opts: NvimSetKeymapOpts<'_>
)

Trait Implementations

impl<'lua> FromLua<'lua> for Api<'lua>

fn from_lua(lua_value: LuaValue<'lua>, lua: &'lua Lua) -> LuaResult<Self>

Auto Trait Implementations

impl<'lua> !RefUnwindSafe for Api<'lua>

impl<'lua> !Send for Api<'lua>

impl<'lua> !Sync for Api<'lua>

impl<'lua> Unpin for Api<'lua>

impl<'lua> !UnwindSafe for Api<'lua>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<'lua, T> FromLuaMulti<'lua> for T where
T: FromLua<'lua>,

fn from_lua_multi(values: MultiValue<'lua>, lua: &'lua Lua) -> Result<T, Error>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct nvim::api::Api

Implementations

impl<'lua> Api<'lua>

pub fn nvim__get_runtime( &self, pat: &[&str], all: bool, opts: NvimGetRuntimeOpts) -> LuaValue<'_>

pub fn nvim_buf_create_user_command( &self, buffer: Index, name: String, command: Command<'_>, opts: NvimCreateUserCommandOpts)

pub fn nvim_create_autocmd( &self, events: Vec<String>, opts: NvimCreateAutocmdsOpts<'_>) -> i64

pub fn nvim_exec(&self, src: &str, output: bool) -> String

pub fn nvim_get_autocmds(&self, opts: NvimGetAutocmdsOpts) -> Vec<AutoCmd>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn nvim_get_runtime_file(&self, glob: &str, all: bool) -> Vec<String>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

pub fn nvim_set_keymap( &self, mode: Mode, lhs: &str, rhs: &str, opts: NvimSetKeymapOpts<'_>)

Trait Implementations

impl<'lua> FromLua<'lua> for Api<'lua>

fn from_lua(lua_value: LuaValue<'lua>, lua: &'lua Lua) -> LuaResult<Self>

Auto Trait Implementations

impl<'lua> !RefUnwindSafe for Api<'lua>

impl<'lua> !Send for Api<'lua>

impl<'lua> !Sync for Api<'lua>

impl<'lua> Unpin for Api<'lua>

impl<'lua> !UnwindSafe for Api<'lua>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<'lua, T> FromLuaMulti<'lua> for T where T: FromLua<'lua>,

fn from_lua_multi(values: MultiValue<'lua>, lua: &'lua Lua) -> Result<T, Error>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

pub fn nvim__get_runtime(
&self,
pat: &[&str ],
all: bool,
opts: NvimGetRuntimeOpts
) -> LuaValue<'_>

pub fn nvim_buf_create_user_command(
&self,
buffer: Index,
name: String,
command: Command<'_>,
opts: NvimCreateUserCommandOpts
)

pub fn nvim_create_autocmd(
&self,
events: Vec<String>,
opts: NvimCreateAutocmdsOpts<'_>
) -> i64

pub fn nvim_get_autocmds(&self, opts: NvimGetAutocmdsOpts) -> Vec<AutoCmd>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn nvim_get_runtime_file(&self, glob: &str, all: bool) -> Vec<String>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

pub fn nvim_set_keymap(
&self,
mode: Mode,
lhs: &str,
rhs: &str,
opts: NvimSetKeymapOpts<'_>
)

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

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

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

impl<'lua, T> FromLuaMulti<'lua> for T where
T: FromLua<'lua>,

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

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

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