nvim-api 0.2.0

Neovim API bindings
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

use derive_builder::Builder;
use nvim_types::{self as nvim, Dictionary, Object};

use crate::Buffer;
use crate::ToFunction;

/// Arguments passed to the callback registered to
/// [`on_input`](OpenTermOptsBuilder::on_input). The `(a, b, c, d)` tuple
/// represents:
///
/// - `a`: the string literal `"input"`;
/// - `b`: channel id;
/// - `c`: the [`Buffer`] associated to the terminal instance;
/// - `d`: data input.
pub type OnInputArgs = (
    String,       // the string literal `"input"`
    u32,          // channel_id
    Buffer,       // buffer
    nvim::String, // data input
);

#[derive(Clone, Debug, Default, Builder)]
#[builder(default, build_fn(private, name = "fallible_build"))]
pub struct OpenTermOpts {
    #[builder(setter(custom))]
    on_input: Object,
}

impl OpenTermOpts {
    #[inline(always)]
    /// Creates a new [`OpenTermOptsBuilder`].
    pub fn builder() -> OpenTermOptsBuilder {
        OpenTermOptsBuilder::default()
    }
}

impl OpenTermOptsBuilder {
    /// Callback invoked on data input (like keypresses in terminal mode).
    pub fn on_input<F>(&mut self, fun: F) -> &mut Self
    where
        F: ToFunction<OnInputArgs, ()>,
    {
        self.on_input = Some(fun.to_object());
        self
    }

    pub fn build(&mut self) -> OpenTermOpts {
        self.fallible_build().expect("never fails, all fields have defaults")
    }
}

impl From<&OpenTermOpts> for Dictionary {
    fn from(opts: &OpenTermOpts) -> Self {
        Self::from_iter([("on_input", opts.on_input.clone())])
    }
}