nvim-utils 0.1.12

Utilities for writing neovim plugins in rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

//! Corresponds to `vim.fn`
use std::path::PathBuf;

use crate::prelude::*;

/// Gets the `vim.fn` table
pub fn get(lua: &Lua) -> LuaResult<LuaTable> {
    vim::get(lua)?.get::<_, LuaTable>("fn")
}

/// Corresponds to `vim.fn.stdpath`
pub fn stdpath(lua: &Lua, path: &str) -> LuaResult<String> {
    self::get(lua)?.get::<_, LuaFunction>("stdpath")?.call(path)
}

/// Corresponds to `vim.fn.tmpname`
pub fn tmpname(lua: &Lua) -> LuaResult<String> {
    self::get(lua)?.get::<_, LuaFunction>("tempname")?.call(())
}

/// Corresponds to `vim.fn.line`
pub fn line(lua: &Lua, line: &str) -> LuaResult<u64> {
    self::get(lua)?.get::<_, LuaFunction>("line")?.call(line)
}

/// Corresponds to `vim.fn.foldclosedend`
pub fn foldclosedend(lua: &Lua, line: u64) -> LuaResult<i64> {
    self::get(lua)?
        .get::<_, LuaFunction>("foldclosedend")?
        .call(line)
}

/// Corresponds to `vim.fn.foldclosed`
pub fn foldclosed(lua: &Lua, line: u64) -> LuaResult<i64> {
    vim::func::get(lua)?.call_function("foldclosed", line)
}

/// Corresponds to `vim.fn.indent`
pub fn indent(lua: &Lua, line: u64) -> LuaResult<u64> {
    self::get(lua)?.get::<_, LuaFunction>("indent")?.call(line)
}

/// Corresponds to `vim.fn.shiftwidth`
pub fn shiftwidth(lua: &Lua) -> LuaResult<u64> {
    self::get(lua)?
        .get::<_, LuaFunction>("shiftwidth")?
        .call(())
}

/// The result of a GetLine call, either a string or a table (array) of strings
/// Can be used with match, or if you know the type you can use `into_string` or `into_table`
#[derive(Debug, Clone)]
pub enum GetLineResult {
    String(String),
    Table(Vec<String>),
}

impl<'a> FromLua<'a> for GetLineResult {
    fn from_lua(val: LuaValue<'a>, lua: &'a Lua) -> LuaResult<Self> {
        match &val {
            LuaValue::String(_) => Ok(GetLineResult::String(lua.unpack(val)?)),
            LuaValue::Table(_) => Ok(GetLineResult::Table(lua.unpack(val)?)),
            _ => Err(LuaError::FromLuaConversionError {
                from: "LuaValue",
                to: "GetLineResult",
                message: Some("Invalid type".to_string()),
            }),
        }
    }
}

impl GetLineResult {
    pub fn into_string(self) -> LuaResult<String> {
        match self {
            GetLineResult::String(s) => Ok(s),
            _ => Err(LuaError::FromLuaConversionError {
                from: "LuaValue",
                to: "GetLineResult",
                message: Some("Invalid type".to_string()),
            }),
        }
    }

    pub fn into_table(self) -> LuaResult<Vec<String>> {
        match self {
            GetLineResult::Table(t) => Ok(t),
            _ => Err(LuaError::FromLuaConversionError {
                from: "LuaValue",
                to: "GetLineResult",
                message: Some("Invalid type".to_string()),
            }),
        }
    }
}

/// Corresponds to `vim.fn.getline`
pub fn getline(lua: &Lua, line: u64, end: Option<u64>) -> LuaResult<GetLineResult> {
    let val = if let Some(end) = end {
        self::get(lua)?.call_function("getline", (line, end))?
    } else {
        self::get(lua)?
            .get::<_, LuaFunction>("getline")?
            .call(line)?
    };
    match &val {
        LuaValue::String(_) => Ok(GetLineResult::String(String::from_lua(val, lua)?)),
        LuaValue::Table(_) => Ok(GetLineResult::Table(lua.unpack(val)?)),
        _ => Err(LuaError::FromLuaConversionError {
            from: "LuaValue",
            to: "GetLineResult",
            message: Some("Invalid type".to_string()),
        }),
    }
}

/// Corresponds to `vim.fn.setline`
pub fn setline(lua: &Lua, line: u64, text: &str) -> LuaResult<bool> {
    self::get(lua)?
        .get::<_, LuaFunction>("setline")?
        .call((line, text))
}

/// Corresponds to `vim.fn.getcwd`
pub fn getcwd(lua: &Lua, win_num: Option<u64>, tab_num: Option<u64>) -> LuaResult<PathBuf> {
    let cwd = self::get(lua)?
        .call_function::<_, _, String>("getcwd", (win_num.unwrap_or(0), tab_num.unwrap_or(0)))?;
    Ok(PathBuf::from(cwd))
}

/// Corresponds to `vim.fn.mode`
pub fn mode(lua: &Lua) -> LuaResult<String> {
    vim::func::get(lua)?.call_function("mode", ())
}