Struct 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

pub fn cursorline_hl_group<Hl: HlGroup>( &mut self, cursorline_hl_group: Hl, ) -> &mut Self

Name of the highlight group used to highlight the line when the cursor

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

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

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

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

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

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

Whether to continue the highlight for the rest of the screen line for

pub fn hl_group<Hl: HlGroup>(&mut self, hl_group: Hl) -> &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 invalidate(&mut self, invalidate: bool) -> &mut Self

pub fn line_hl_group<Hl: HlGroup>(&mut self, line_hl_group: Hl) -> &mut Self

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

pub fn number_hl_group<Hl: HlGroup>(&mut self, number_hl_group: Hl) -> &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

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

Indicates the direction the extmark will be shifted in when new text is

pub fn scoped(&mut self, scoped: Boolean) -> &mut Self

pub fn sign_hl_group<Hl: HlGroup>(&mut self, sign_hl_group: Hl) -> &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 spell(&mut self, spell: bool) -> &mut Self

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

Whether the extmark should not be placed if the line or column value is

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

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

Whether to restore the exact position of the mark if text around the

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

A URL to associate with this extmark.

pub fn virt_lines<Txt: Into<String>, Hl: StringOrListOfStrings, Cnk: IntoIterator<Item = (Txt, Hl)>, ChunkyCnk: IntoIterator<Item = Cnk>>( &mut self, virt_lines: ChunkyCnk, ) -> &mut Self

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

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

Whether to place extmarks in the leftmost column of the ewindow,

pub fn virt_text<Txt: Into<String>, Hl: StringOrListOfStrings, Cnk: IntoIterator<Item = (Txt, Hl)>>( &mut self, virt_text: Cnk, ) -> &mut Self

Virtual text to link to this mark. Every (text, highlights) tuple

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

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

Position of the virtual text.

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

Whether to repeat the virtual text on wrapped lines.

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

pub fn build(&mut self) -> SetExtmarkOpts

Trait Implementations

impl Clone for SetExtmarkOptsBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SetExtmarkOptsBuilder

fn default() -> Self

Returns the “default value” for a type.