Struct RgSource 

pub struct RgSource {
    pub items: Arc<Mutex<Vec<RgMatch>>>,
    /* private fields */
}

Source for the ripgrep content-search picker.

Bonsai-agnostic — preview returns the file contents only. The host (e.g. apps/hjkl) layers syntax spans via preview_path.

Fields

items: Arc<Mutex<Vec<RgMatch>>>

Implementations

impl RgSource

pub fn new(root: PathBuf) -> Self

Trait Implementations

impl PickerLogic for RgSource

fn title(&self) -> &str

Title shown above the input row (e.g. “files”, “buffers”, “grep”).

fn requery_mode(&self) -> RequeryMode

How the picker should react when the query changes.

fn item_count(&self) -> usize

Number of items currently available (grows as enumeration progresses).

fn label(&self, idx: usize) -> String

Display label for the row at idx.

fn match_text(&self, idx: usize) -> String

Text the fuzzy scorer scores against. May equal label.

fn has_preview(&self) -> bool

Whether this source wants the preview pane.

fn preview(&self, idx: usize) -> (Buffer, String)

Build the preview pane for the row. Default: empty buffer.

fn preview_path(&self, idx: usize) -> Option<PathBuf>

File-system path the preview’s content was loaded from, when one exists. Used by the host to drive language-aware preview rendering (e.g. tree-sitter syntax highlighting). Default None for sources whose preview has no on-disk path (an in-memory snapshot, a help message, etc.).

fn preview_top_row(&self, idx: usize) -> usize

Initial scroll position (top row) for the preview viewport. Sources that show a windowed preview around a specific line override this so the gutter line numbers reflect the actual file line. Default 0.

fn preview_match_row(&self, idx: usize) -> Option<usize>

0-based row to visually mark in the preview (e.g. grep match line). Default None → no highlight. Returning Some(row) tells the renderer to paint a cursor_line_bg across that row.

fn select(&self, _idx: usize) -> PickerAction

Translate the picked row into an action.

fn label_match_positions( &self, idx: usize, query: &str, label: &str, ) -> Option<Vec<usize>>

Override the highlight positions for the row at idx.

fn enumerate( &mut self, query: Option<&str>, cancel: Arc<AtomicBool>, ) -> Option<JoinHandle<()>>

Re-enumerate items.

fn preview_line_offset(&self, idx: usize) -> usize

Added to the gutter line numbers in the preview. Sources that snapshot a window of a larger document (e.g. buffer picker snapshotting ±N lines around the cursor) use this so the gutter shows the original document line numbers rather than restarting at 1. Default 0.

fn handle_key(&self, idx: usize, key: KeyEvent) -> Option<PickerAction>

Handle a key before the picker’s default handling. Return Some(action) to short-circuit and emit that action immediately. Return None to let the picker handle the key normally. Default: None.

fn preserve_source_order(&self) -> bool

Whether the picker should keep the source’s enumeration order when the query is empty. Default false means empty-query rows are sorted by match-text ascending. Sources that pre-sort meaningfully (e.g. by recency, by HEAD-first) override to true.

fn label_styles( &self, idx: usize, label: &str, ) -> Option<Vec<(Range<usize>, Style)>>

Optional per-row semantic styling for the label. Char-index ranges into the label with a base style. Fuzzy-match positions overlay these. Default None means no extra styling.