Skip to main content

AutoPairsHook

Struct AutoPairsHook 

Source
pub struct AutoPairsHook;
Expand description

Built-in hook that automatically inserts closing quotes, brackets, and braces, wraps selected text, and steps over closing pairs.

Implementations§

Source§

impl AutoPairsHook

Source

pub fn new() -> Self

Creates a new auto-pairs hook.

Trait Implementations§

Source§

impl Clone for AutoPairsHook

Source§

fn clone(&self) -> AutoPairsHook

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AutoPairsHook

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for AutoPairsHook

Source§

fn default() -> AutoPairsHook

Returns the “default value” for a type. Read more
Source§

impl EditorHook for AutoPairsHook

Source§

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

Intercepts a key press before standard editor processing.
Source§

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

Handles a synthetic search-panel action (prompt-bar clicks). Read more
Source§

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

Intercepts text insertion before it is written to the buffer.
Source§

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

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

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

Called whenever the cursor offset or selection range changes.
Source§

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. Read more
Source§

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

Contributes right-click context menu rows for the given click. Read more
Source§

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

Handles activation of a context menu row by id. Read more
Source§

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

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

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

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

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.