Struct VirtualTextManager 

pub struct VirtualTextManager { /* private fields */ }

Manages virtual text entries for a buffer

Uses the marker system for position tracking, so virtual text automatically adjusts when the buffer is edited.

Implementations

impl VirtualTextManager

pub fn new() -> Self

Create a new empty manager

pub fn add( &mut self, marker_list: &mut MarkerList, position: usize, text: String, style: Style, vtext_position: VirtualTextPosition, priority: i32, ) -> VirtualTextId

Add a virtual text entry

Arguments

• marker_list - The marker list to create a position marker in
• position - Byte offset in the buffer
• text - Text to display
• style - Styling for the text
• vtext_position - Whether to render before or after the character
• priority - Ordering priority (higher = later in render order)

Returns

The ID of the created virtual text entry

pub fn add_with_id( &mut self, marker_list: &mut MarkerList, position: usize, text: String, style: Style, vtext_position: VirtualTextPosition, priority: i32, string_id: String, ) -> VirtualTextId

Add a virtual text entry with a string identifier

This is useful for plugins that need to track and remove virtual texts by name.

pub fn add_line( &mut self, marker_list: &mut MarkerList, position: usize, text: String, style: Style, placement: VirtualTextPosition, namespace: VirtualTextNamespace, priority: i32, ) -> VirtualTextId

Add a virtual line (LineAbove or LineBelow) with namespace for bulk removal

This is the primary API for features like git blame headers.

Arguments

• marker_list - The marker list to create a position marker in
• position - Byte offset in the buffer (anchors the line to this position)
• text - Full line content to display
• style - Styling for the line
• placement - LineAbove or LineBelow
• namespace - Namespace for bulk removal (e.g., “git-blame”)
• priority - Ordering when multiple lines at same position

pub fn remove_by_id( &mut self, marker_list: &mut MarkerList, string_id: &str, ) -> bool

Remove a virtual text entry by its string identifier

pub fn remove_by_prefix(&mut self, marker_list: &mut MarkerList, prefix: &str)

Remove all virtual text entries whose string_id starts with the given prefix

pub fn remove( &mut self, marker_list: &mut MarkerList, id: VirtualTextId, ) -> bool

Remove a virtual text entry

pub fn clear(&mut self, marker_list: &mut MarkerList)

Clear all virtual text entries

pub fn len(&self) -> usize

Get the number of virtual text entries

pub fn is_empty(&self) -> bool

Check if there are no virtual text entries

pub fn query_range( &self, marker_list: &MarkerList, start: usize, end: usize, ) -> Vec<(usize, &VirtualText)>

Query virtual texts in a byte range

Returns a vector of (byte_position, &VirtualText) pairs, sorted by:

1. Byte position (ascending)
2. Priority (ascending, so higher priority renders later)

Arguments

• marker_list - The marker list to query positions from
• start - Start byte offset (inclusive)
• end - End byte offset (exclusive)

pub fn build_lookup( &self, marker_list: &MarkerList, start: usize, end: usize, ) -> HashMap<usize, Vec<&VirtualText>>

Build a lookup map for efficient per-character access during rendering

Returns a HashMap where keys are byte positions and values are vectors of virtual texts at that position, sorted by priority.

pub fn clear_namespace( &mut self, marker_list: &mut MarkerList, namespace: &VirtualTextNamespace, )

Clear all virtual texts in a namespace

This is the primary way plugins remove their virtual texts (e.g., before updating blame data).

pub fn query_lines_in_range( &self, marker_list: &MarkerList, start: usize, end: usize, ) -> Vec<(usize, &VirtualText)>

Query only virtual LINES (LineAbove/LineBelow) in a byte range

Used by the render pipeline to inject header/footer lines. Returns (byte_position, &VirtualText) pairs sorted by position then priority.

pub fn query_inline_in_range( &self, marker_list: &MarkerList, start: usize, end: usize, ) -> Vec<(usize, &VirtualText)>

Query only INLINE virtual texts (BeforeChar/AfterChar) in a byte range

Used by the render pipeline to inject inline hints.

pub fn build_lines_lookup( &self, marker_list: &MarkerList, start: usize, end: usize, ) -> HashMap<usize, Vec<&VirtualText>>

Build a lookup map for virtual LINES, keyed by the line’s anchor byte position

For each source line, the renderer can quickly check if there are LineAbove or LineBelow virtual texts anchored to positions within that line.

Trait Implementations

impl Default for VirtualTextManager

fn default() -> Self

Returns the “default value” for a type.