Struct ReferenceHighlightOverlay 

pub struct ReferenceHighlightOverlay {
    pub enabled: bool,
    /* private fields */
}

Manager for reference highlight overlays

Tracks the current word under cursor and manages overlays that highlight all occurrences. Overlays automatically adjust positions via markers.

Fields

enabled: bool

Whether highlighting is enabled

Implementations

impl ReferenceHighlightOverlay

pub fn new() -> Self

Create a new reference highlight overlay manager

pub fn with_debounce(delay_ms: u64) -> Self

Create with custom debounce delay

pub fn update( &mut self, buffer: &Buffer, overlays: &mut OverlayManager, marker_list: &mut MarkerList, highlighter: &mut ReferenceHighlighter, cursor_position: usize, viewport_start: usize, viewport_end: usize, context_bytes: usize, highlight_color: Color, ) -> bool

Update reference highlights based on cursor position

This should be called on each render. It will:

1. Check if cursor is on a different word
2. Debounce rapid cursor movements
3. Update overlays when debounce period elapses

Returns true if overlays were updated

pub fn needs_redraw(&self) -> Option<Duration>

Check if a redraw is needed (debounce timer pending)

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

Force clear all highlights (e.g., when switching buffers)

pub fn is_debouncing(&self) -> bool

Check if currently debouncing

pub fn debounce_delay(&self) -> Duration

Get the debounce delay

Trait Implementations

impl Default for ReferenceHighlightOverlay

fn default() -> Self

Returns the “default value” for a type.