Struct SearchHook 

pub struct SearchHook { /* private fields */ }

A stock hook connecting the headless search engine to the shared prompt.

Keymap (all headless, no frontend code):

• Ctrl+F: open search (selected text becomes the initial query).
• Typing: live match refresh.
• Enter / F3 / Down: next match, Shift+F3 / Up: previous match.
• Alt+Down / Alt+Up: input history (Up/Down navigate matches here).
• Alt+C / Alt+W / Alt+H: flip Match Case / Whole Word / Highlight All (also while active with the prompt closed).
• Ctrl+H: open the replace field; Enter on it stores the replacement and returns to the search prompt (REPLACE mode).
• Ctrl+Enter: replace the current match and advance.
• Alt+A: replace all matches (single undo step).
• Escape: close.

Enter always navigates, even in REPLACE mode. Register this hook before mode hooks (e.g. vim) so its keys win while the prompt is open; unconsumed keys pass through untouched when the prompt is closed.

Implementations

impl SearchHook

pub fn new() -> Self

Creates an idle search hook (case-sensitive, whole-word off, highlight-all on).

pub fn is_active(&self) -> bool

Whether the hook currently owns the open prompt.

pub fn match_count(&self) -> usize

Number of matches for the current query.

pub fn current_match(&self) -> Option<Range<usize>>

The current match range, if navigation has occurred.

pub fn query_text(&self) -> &str

The last submitted query text.

pub fn replacement(&self) -> &str

The stored replacement text.

pub fn case_sensitive(&self) -> bool

Whether matching is case-sensitive.

pub fn whole_word(&self) -> bool

Whether matches must span whole words.

pub fn highlight_all(&self) -> bool

Whether all matches wash the viewport (vs current match only).

pub fn is_replace_mode(&self) -> bool

Whether replace mode is active.

pub fn is_replace_prompt(&self) -> bool

Whether the active input prompt is currently the replace field.

pub fn build_query(&self) -> Option<SearchQuery>

Builds the active query from the text plus toggle flags. Returns None when the query text is empty.

pub fn toggle_case(&mut self, ctx: &mut HookContext<'_>)

Flips Match Case and re-scans.

pub fn toggle_word(&mut self, ctx: &mut HookContext<'_>)

Flips Whole Word and re-scans.

pub fn toggle_highlight(&mut self)

Flips the highlight-all wash (no re-scan needed).

pub fn open_search(&mut self, ctx: &mut HookContext<'_>, initial: &str)

Opens the search prompt with initial as the query.

pub fn open_replace(&mut self, ctx: &mut HookContext<'_>)

Opens the replace prompt, stashing the current query.

pub fn close(&mut self, ctx: &mut HookContext<'_>)

Closes a hook-owned prompt, leaving replace mode.

pub fn toggle_replace(&mut self, ctx: &mut HookContext<'_>)

Toggles replace mode on and off.

pub fn focus_search(&mut self, ctx: &mut HookContext<'_>)

Switches prompt focus to the search query field.

pub fn focus_replace(&mut self, ctx: &mut HookContext<'_>)

Switches prompt focus to the replacement text field.

pub fn navigate_next(&mut self, ctx: &mut HookContext<'_>, wrap: bool) -> bool

Selects the next match at or after the cursor.

Sitting exactly on the current match start steps past it, so repeated Enter / F3 walks forward instead of re-selecting.

pub fn navigate_next_from( &mut self, ctx: &mut HookContext<'_>, from: usize, wrap: bool, ) -> bool

Selects the next match at or after from (see Self::navigate_next).

pub fn navigate_prev(&mut self, ctx: &mut HookContext<'_>, wrap: bool) -> bool

Selects the previous match at or before the cursor.

pub fn navigate_prev_from( &mut self, ctx: &mut HookContext<'_>, from: usize, wrap: bool, ) -> bool

Selects the previous match at or before from.

pub fn replace_current( &mut self, ctx: &mut HookContext<'_>, ) -> Result<bool, EditorError>

Replaces the match containing the cursor (else the next match) and advances to the following match. Returns Ok(false) when there is nothing to replace.

pub fn replace_all( &mut self, ctx: &mut HookContext<'_>, ) -> Result<usize, EditorError>

Replaces all matches as a single undoable transaction, reporting the count in the prompt message. Returns the number of replacements.

Trait Implementations

impl Clone for SearchHook

fn clone(&self) -> SearchHook

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchHook

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

Formats the value using the given formatter.

impl Default for SearchHook

fn default() -> Self

Returns the “default value” for a type.

impl EditorHook for SearchHook

fn on_search_action( &mut self, ctx: &mut HookContext<'_>, action: SearchAction, ) -> HookOutcome

Handles a synthetic search-panel action (prompt-bar clicks).

fn on_key(&mut self, ctx: &mut HookContext<'_>, event: &KeyEvent) -> HookOutcome

Intercepts a key press before standard editor processing.

fn status_text(&self) -> Option<&str>

Returns a human-readable status or active mode name, if any.

fn search_snapshot(&self) -> Option<SearchSnapshot>

Returns a live search-panel snapshot for renderers (toggles, matches).

fn before_insert( &mut self, _ctx: &mut HookContext<'_>, _text: char, ) -> HookOutcome

Intercepts text insertion before it is written to the buffer.

fn after_edit(&mut self, _buffer: &mut EditorBuffer)

Called immediately after any buffer mutation (typing, deletions, paste, undo/redo).

fn on_selection_change( &mut self, _buffer: &EditorBuffer, _selection: Option<&Selection>, )

Called whenever the cursor offset or selection range changes.

fn on_click( &mut self, _ctx: &mut HookContext<'_>, _row: usize, _col: usize, ) -> HookOutcome

Intercepts a mouse click at a given buffer line and source byte column.

fn context_menu_items( &self, _ctx: &ContextMenuContext<'_>, ) -> Vec<ContextMenuItem>

Contributes right-click context menu rows for the given click.

fn on_context_menu_action( &mut self, _ctx: &mut HookContext<'_>, _id: &str, ) -> HookOutcome

Handles activation of a context menu row by id.