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
Core buffer, syntax, movement, and hook primitives. 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>,
) -> HookContext<'a>
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>, ) -> HookContext<'a>
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more