Struct GrepSource 

pub struct GrepSource {
    pub spec: PickerSourceSpec,
    pub config: Arc<ConfigRegistry>,
    pub highlighter: Option<Arc<dyn GrepPreviewHighlighter>>,
}

Fields

spec: PickerSourceSpec

config: Arc<ConfigRegistry>

highlighter: Option<Arc<dyn GrepPreviewHighlighter>>

PH.3: optional preview highlighter, captured at construction like config. None ⇒ plain previews (e.g. tests, or a host that doesn’t wire syntax).

Implementations

impl GrepSource

pub fn new( config: Arc<ConfigRegistry>, highlighter: Option<Arc<dyn GrepPreviewHighlighter>>, ) -> GrepSource

Trait Implementations

impl PickerSourceGenerator for GrepSource

fn init( &self, ctx: &PickerContext<'_>, args: &[String], ) -> Result<PickerInitResult, String>

Slice 3: optional initial pattern. With no pattern the picker opens empty (no grep runs); the first keystroke triggers the live flow through on_query_changed. With an initial pattern the grep runs immediately – async via the Future variant so the UI thread doesn’t park on the first invocation either. The host seeds picker.query with the initial pattern (live-source convention in App::open_picker), so subsequent keystrokes extend the same query.

fn on_query_changed( &self, ctx: &PickerContext<'_>, query: &str, ) -> Option<Result<PickerInitResult, String>>

Slice 3: live re-execution. The host’s drain_pending_live_picker_query calls this every time the debounce expires; we trim, special-case the empty query (no grep, empty result – clears the candidate list), and otherwise spawn the grep on the blocking pool. The Future variant lets the host cancel us if a newer keystroke fires before we finish.

fn spec(&self) -> &PickerSourceSpec

Generator metadata. Returned by reference so the registry can stamp it into :describe-picker / :picker <Tab> listings without cloning.

fn accept( &self, _ctx: &PickerContext<'_>, routing: &RoutingPayload, ) -> Result<PickerAcceptOutcome, String>

Translate the user’s chosen routing payload into a typed PickerAcceptOutcome the host applies. The generator owns the mapping from its emitted routing-payload variant(s) to outcome(s); mismatch returns Err, which the host echoes.

fn accept_async( &self, _ctx: &PickerContext<'_>, _routing: &RoutingPayload, ) -> Option<Pin<Box<dyn Future<Output = Result<PickerAcceptOutcome, String>> + Send>>>

Async-accept hook. Default None means “this source resolves accept synchronously” — every native source takes this path and is unchanged.

fn descend( &self, _ctx: &PickerContext<'_>, _candidate: &RawCandidate, ) -> Option<String>

PC.10: <C-l> — refine the query from the selected candidate instead of accepting it.

fn ascend(&self, _query: &str) -> Option<String>

PC.10: <C-w> (<C-h> until PH.1) — descend’s peer, one level out.

fn accept_navigates( &self, _ctx: &PickerContext<'_>, _candidate: &RawCandidate, ) -> Option<String>

PP.3: <CR> on a row that is a SIGNPOST rather than a destination.

fn initial_query(&self, _args: &[String]) -> Option<String>

PP.1: the query the picker opens WITH.

fn preview( &self, _ctx: &PickerContext<'_>, _routing: &RoutingPayload, ) -> Option<PickerPreviewOutcome>

T.12: live-preview hook — invoked as the picker SELECTION moves to a candidate (before accept). Default None = no preview. A source returns an outcome the host applies immediately for a live preview; the host restores prior state on .

fn preview_debounce(&self) -> Option<Duration>

MG.54: how long the selection must sit still before the host calls preview. None (the default) = call it inline on every selection move, which is right for a source whose preview is a cheap projection of data it already holds.

fn owner_plugin(&self) -> Option<u64>

PH.1: the host-issued id of the plugin that contributed this source, None for a native one.