pub struct HookContext<'a> {
pub buffer: &'a mut EditorBuffer,
pub selection: &'a mut Option<Selection>,
pub cursor_style: &'a mut CursorStyle,
pub prompt: &'a mut PromptState,
pub effects: &'a mut Vec<HookEffect>,
}Expand description
The mutable editing context passed to editor hooks during events.
prompt is the shared headless input box (bottom bar / command palette):
any hook can open it, read submitted input, and fill item rows, with no
frontend code. effects collects app-level requests (save/load/quit)
that the host drains after each event.
Fields§
§buffer: &'a mut EditorBufferMutable access to the underlying text buffer.
selection: &'a mut Option<Selection>Mutable access to the active selection range, if any.
cursor_style: &'a mut CursorStyleMutable access to the cursor visual style.
prompt: &'a mut PromptStateShared headless prompt / input-box state.
effects: &'a mut Vec<HookEffect>App-level requests for the host to drain after the event.
Implementations§
Source§impl<'a> HookContext<'a>
impl<'a> HookContext<'a>
Sourcepub fn new(
buffer: &'a mut EditorBuffer,
selection: &'a mut Option<Selection>,
cursor_style: &'a mut CursorStyle,
prompt: &'a mut PromptState,
effects: &'a mut Vec<HookEffect>,
) -> Self
pub fn new( buffer: &'a mut EditorBuffer, selection: &'a mut Option<Selection>, cursor_style: &'a mut CursorStyle, prompt: &'a mut PromptState, effects: &'a mut Vec<HookEffect>, ) -> Self
Creates a new hook context.
Auto Trait Implementations§
impl<'a> !UnwindSafe for HookContext<'a>
impl<'a> Freeze for HookContext<'a>
impl<'a> RefUnwindSafe for HookContext<'a>
impl<'a> Send for HookContext<'a>
impl<'a> Sync for HookContext<'a>
impl<'a> Unpin for HookContext<'a>
impl<'a> UnsafeUnpin for HookContext<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more