Struct VirtualText 

pub struct VirtualText {
    pub marker_id: MarkerId,
    pub text: String,
    pub style: Style,
    pub fg_theme_key: Option<String>,
    pub bg_theme_key: Option<String>,
    pub position: VirtualTextPosition,
    pub priority: i32,
    pub string_id: Option<String>,
    pub namespace: Option<VirtualTextNamespace>,
}

A piece of virtual text to render at a specific position

Fields

marker_id: MarkerId

Marker tracking the position (auto-adjusts on edits)

text: String

Text to display (for LineAbove/LineBelow, this is the full line content)

style: Style

Fallback styling, used when the theme-key fields below are unset OR the keys don’t resolve in the active theme. The renderer composes the final style by overlaying any resolved theme colours on top of this fallback (see VirtualText::resolved_style).

fg_theme_key: Option<String>

Optional theme key for the foreground colour (e.g. "editor.line_number_fg"). Resolved on every render so the line follows live theme changes.

bg_theme_key: Option<String>

Optional theme key for the background colour.

position: VirtualTextPosition

Where to render relative to the marker position

priority: i32

Priority for ordering multiple items at same position (higher = later)

string_id: Option<String>

Optional string identifier for this virtual text (for plugin use)

namespace: Option<VirtualTextNamespace>

Optional namespace for bulk removal (like Overlay’s namespace)

Implementations

impl VirtualText

pub fn resolved_style(&self, theme: &Theme) -> Style

Resolve the on-screen Style for this entry against a live theme.

Theme keys take precedence over the fallback style’s fg/bg. If a key fails to resolve (e.g. the theme doesn’t define it), the fallback colour is kept. Modifiers from style (bold/italic/etc.) always survive.

Trait Implementations

impl Clone for VirtualText

fn clone(&self) -> VirtualText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualText

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.