Struct nvim_oxi_api::opts::SetExtmarkOptsBuilder

pub struct SetExtmarkOptsBuilder(/* private fields */);

Implementations

impl SetExtmarkOptsBuilder

pub fn conceal(&mut self, conceal: Option<char>) -> &mut Self

Enable concealing symilar to :syn-conceal. If a character is supplied it is used as :syn-cchar.

hl_group is used to highlight the character if provided, otherwise it defaults to hl-Conceal.

pub fn cursorline_hl_group(&mut self, cursorline_hl_group: &str) -> &mut Self

Name of the highlight group used to highlight the line when the cursor is on the same line as the mark and cursorline is enabled.

pub fn end_col(&mut self, end_col: usize) -> &mut Self

Ending line of the mark. 0-indexed and exclusive.

pub fn end_right_gravity(&mut self, end_right_gravity: bool) -> &mut Self

Indicates the direction the extmark’s end position (if it exists) will be shifted in when new text is inserted (true for right, false for left). Defaults to left.

pub fn end_row(&mut self, end_row: usize) -> &mut Self

Ending line of the mark. 0-indexed and inclusive.

pub fn ephemeral(&mut self, ephemeral: bool) -> &mut Self

For use with set_decoration_provider() callbacks. The mark will only be used for the current redraw cycle, and not be permanently stored in the buffer.

pub fn hl_eol(&mut self, hl_eol: bool) -> &mut Self

Whether to continue the highlight for the rest of the screen line for multiline highlights covering the EOL of a line.

pub fn hl_group(&mut self, hl_group: &str) -> &mut Self

Name of the highlight group used to highlight this mark.

pub fn hl_mode(&mut self, hl_mode: ExtmarkHlMode) -> &mut Self

Controls how highlights are combined with the highlights of the text.

pub fn id(&mut self, id: u32) -> &mut Self

Id of the extmark to edit.

pub fn line_hl_group(&mut self, line_hl_group: &str) -> &mut Self

Name of the highlight group used to highlight the whole line.

pub fn number_hl_group(&mut self, number_hl_group: &str) -> &mut Self

Name of the highlight group used to highlight the number column.

pub fn priority(&mut self, priority: u32) -> &mut Self

A priority value for the highlight group. For example, treesitter highlights use a value of 100.

pub fn right_gravity(&mut self, right_gravity: bool) -> &mut Self

Indicates the direction the extmark will be shifted in when new text is inserted (true for right, false for left). Defaults to right.

pub fn sign_hl_group(&mut self, sign_hl_group: &str) -> &mut Self

Name of the highlight group used to highlight the sign column text.

pub fn sign_text(&mut self, sign_text: &str) -> &mut Self

Text to display in the sign column. Should take up 1-2 display cells.

pub fn strict(&mut self, strict: bool) -> &mut Self

Whether the extmark should not be placed if the line or column value is past the end of the buffer or end of the line, respectively. Defaults to true.

pub fn ui_watched(&mut self, ui_watched: bool) -> &mut Self

Whether the mark should be drawn by an external UI. When true the UI will receive win_extmark events.

pub fn virt_lines<Txt, Hl, Cnk, ChunkyCnk>( &mut self, virt_lines: ChunkyCnk ) -> &mut Self

where ChunkyCnk: IntoIterator<Item = Cnk>, Cnk: IntoIterator<Item = (Txt, Hl)>, Txt: Into<String>, Hl: StringOrListOfStrings,

Virtual lines to add next to the mark.

pub fn virt_lines_above(&mut self, virt_lines_above: bool) -> &mut Self

Whether to place virtual lines above the buffer line containing the mark.

pub fn virt_lines_leftcol(&mut self, virt_lines_leftcol: bool) -> &mut Self

Whether to place extmarks in the leftmost column of the ewindow, bypassing sign and number columns.

pub fn virt_text<Txt, Hl, Cnk>(&mut self, virt_text: Cnk) -> &mut Self

where Cnk: IntoIterator<Item = (Txt, Hl)>, Txt: Into<String>, Hl: StringOrListOfStrings,

Virtual text to link to this mark. Every (text, highlights) tuple represents a text chunk with a specified highlight. The highlights specified in highlights will be combined together, with the highest priority highlight beign applied last. Each highlight group can either be a string or an integer, the latter obtained using get_hl_id_by_name().

pub fn virt_text_hide(&mut self, virt_text_hide: bool) -> &mut Self

Whether to hide the virtual text when the background text is selected or hidden due to horizontal scroll.

pub fn virt_text_pos( &mut self, virt_text_pos: ExtmarkVirtTextPosition ) -> &mut Self

Position of the virtual text.

pub fn virt_text_win_col(&mut self, virt_text_win_col: u32) -> &mut Self

Position the virtual text at a fixed window column (starting from the first text column).

pub fn build(&mut self) -> SetExtmarkOpts

Trait Implementations

impl Clone for SetExtmarkOptsBuilder

fn clone(&self) -> SetExtmarkOptsBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for SetExtmarkOptsBuilder

fn default() -> SetExtmarkOptsBuilder

Returns the “default value” for a type.