nvim_oxi_api/opts/
get_highlight.rs

1use types::{String as NvimString, *};
2
3/// Option passed to [`get_hl()`][crate::get_hl].
4#[derive(Clone, Debug, Default, macros::OptsBuilder)]
5#[repr(C)]
6pub struct GetHighlightOpts {
7    #[builder(mask)]
8    mask: u64,
9
10    /// Get a highlight definition by id.
11    #[builder(argtype = "u32", inline = "{0} as Integer")]
12    id: Integer,
13
14    /// Get a highlight definition by name.
15    #[builder(
16        generics = "S: Into<types::String>",
17        argtype = "S",
18        inline = "{0}.into()"
19    )]
20    name: NvimString,
21
22    /// Show linked group name instead of effective definition (default is
23    /// `true`).
24    #[builder(argtype = "bool")]
25    link: Boolean,
26
27    /// When highlight group doesn't exist create it (default is
28    /// `true`).
29    #[builder(argtype = "bool")]
30    create: Boolean,
31}