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
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

use derive_builder::Builder;
use nvim_types::{self as nvim, Array, Function, NonOwning, Object};

use crate::types::AutocmdCallbackArgs;
use crate::Buffer;
use crate::StringOrInt;

pub type ShouldDeleteAutocmd = bool;

/// Options passed to `crate::create_autocmd`.
#[derive(Clone, Debug, Default, Builder)]
#[builder(default, build_fn(private, name = "fallible_build"))]
pub struct CreateAutocmdOpts {
    /// A specific `Buffer` for buffer-local autocommands.
    #[builder(setter(into, strip_option))]
    buffer: Option<Buffer>,

    /// Description of the autocommand.
    #[builder(setter(custom))]
    desc: Object,

    /// Callback to execute when the autocommand is triggered. Cannot be used
    /// together with `command`.
    #[builder(setter(custom))]
    callback: Object,

    /// Vim command to execute when the autocommand is triggered. Cannot be
    /// used together with `callback`.
    #[builder(setter(custom))]
    command: Object,

    /// The autocommand group name or id to match against.
    #[builder(setter(custom))]
    group: Object,

    /// Run nested autocommands.
    #[builder(setter(strip_option))]
    nested: Option<bool>,

    /// Only run the autocommand once.
    #[builder(setter(strip_option))]
    once: Option<bool>,

    /// Patterns to match against.
    #[builder(setter(custom))]
    patterns: Object,
}

impl CreateAutocmdOpts {
    #[inline(always)]
    pub fn builder() -> CreateAutocmdOptsBuilder {
        CreateAutocmdOptsBuilder::default()
    }
}

impl CreateAutocmdOptsBuilder {
    pub fn callback<F>(&mut self, callback: F) -> &mut Self
    where
        F: Into<Function<AutocmdCallbackArgs, ShouldDeleteAutocmd>>,
    {
        self.callback = Some(callback.into().into());
        self
    }

    pub fn command<S>(&mut self, command: S) -> &mut Self
    where
        S: Into<nvim::String>,
    {
        self.command = Some(command.into().into());
        self
    }

    pub fn desc<S>(&mut self, desc: S) -> &mut Self
    where
        S: Into<nvim::String>,
    {
        self.desc = Some(desc.into().into());
        self
    }

    pub fn group<Grp>(&mut self, group: Grp) -> &mut Self
    where
        Grp: StringOrInt,
    {
        self.group = Some(group.to_object());
        self
    }

    pub fn patterns<'a, I>(&mut self, patterns: I) -> &mut Self
    where
        I: IntoIterator<Item = &'a str>,
    {
        self.patterns = Some(Array::from_iter(patterns).into());
        self
    }

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

#[derive(Default)]
#[allow(non_camel_case_types)]
#[repr(C)]
pub(crate) struct KeyDict_create_autocmd<'a> {
    desc: NonOwning<'a, Object>,
    once: Object,
    group: NonOwning<'a, Object>,
    buffer: Object,
    nested: Object,
    command: NonOwning<'a, Object>,
    pattern: NonOwning<'a, Object>,
    callback: NonOwning<'a, Object>,
}

impl<'a> From<&'a CreateAutocmdOpts> for KeyDict_create_autocmd<'a> {
    fn from(opts: &'a CreateAutocmdOpts) -> Self {
        Self {
            desc: opts.desc.non_owning(),
            once: opts.once.into(),
            group: opts.group.non_owning(),
            buffer: opts.buffer.as_ref().into(),
            nested: opts.nested.into(),
            command: opts.command.non_owning(),
            pattern: opts.patterns.non_owning(),
            callback: opts.callback.non_owning(),
        }
    }
}