Struct modalkit::editing::store::Store

pub struct Store<I: ApplicationInfo> {
    pub buffers: BufferStore<I>,
    pub completions: CompletionStore,
    pub digraphs: DigraphStore,
    pub registers: RegisterStore,
    pub cursors: CursorStore<I>,
    pub commands: HistoryList<EditRope>,
    pub searches: HistoryList<EditRope>,
    pub application: I::Store,
}

Global editing context

Fields

buffers: BufferStore<I>

Tracks what buffers have been created.

completions: CompletionStore

Tracks information used for text completions.

digraphs: DigraphStore

Tracks mapped digraphs.

registers: RegisterStore

Tracks the current value of each Register.

cursors: CursorStore<I>

Tracks globally-relevant cursors and cursor groups.

commands: HistoryList<EditRope>

Tracks previous commands.

searches: HistoryList<EditRope>

Tracks previous search expressions.

application: I::Store

Application-specific storage.

Implementations

impl<I> Store<I>

where I: ApplicationInfo,

pub fn new(application: I::Store) -> Self

Create a new Store using an already initialized application store.

pub fn shared(self) -> SharedStore<I>

Wrap this store so that it can be shared between threads.

pub fn load_buffer(&mut self, id: I::ContentId) -> SharedBuffer<I>

Get a buffer via its identifier.

pub fn set_aborted_cmd<T: Into<EditRope>>(&mut self, text: T)

Add a command to the command history after the prompt has been aborted.

This will not update Register::LastCommand.

pub fn set_aborted_search<T: Into<EditRope>>(&mut self, text: T)

Add a search query to the search history after the prompt has been aborted.

This will not update Register::LastSearch.

pub fn set_last_cmd<T: Into<EditRope>>(&mut self, text: T)

Add a command to the command history, and set Register::LastCommand.

pub fn set_last_search<T: Into<EditRope>>(&mut self, text: T)

Add a search query to the search history, and set Register::LastSearch.

Trait Implementations

impl<I> Default for Store<I>

where I: ApplicationInfo, I::Store: Default,

fn default() -> Self

Returns the “default value” for a type.

impl<'a, I> Editable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for SharedBuffer<I>

where I: ApplicationInfo,

fn editor_command( &mut self, act: &EditorAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Execute an editor action.

impl<'a, I> Editable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn editor_command( &mut self, act: &EditorAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Execute an editor action.

impl<'a, I> EditorActions<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn edit( &mut self, action: &EditAction, target: &EditTarget, ictx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Perform an editing operation over the targeted text.

fn mark( &mut self, name: Mark, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Create or update a cursor mark based on the leader’s cursor position.

fn complete( &mut self, comptype: &CompletionType, selection: &CompletionSelection, display: &CompletionDisplay, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Complete the text before the cursor group leader.

fn insert_text( &mut self, act: &InsertTextAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Insert text relative to the current cursor position.

fn selection_command( &mut self, act: &SelectionAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Modify the current selection.

fn cursor_command( &mut self, act: &CursorAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Perform an action over a cursor group.

fn history_command( &mut self, act: &HistoryAction, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> EditResult<EditInfo, I>

Move to a different point in the buffer’s editing history.

impl<'a, I> Searchable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for SharedBuffer<I>

where I: ApplicationInfo,

fn search( &mut self, dir: MoveDirMod, count: Count, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> UIResult<EditInfo, I>

Search for the n^th result in MoveDirMod direction.

impl<'a, I> Searchable<(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), Store<I>, I> for EditBuffer<I>

where I: ApplicationInfo,

fn search( &mut self, dir: MoveDirMod, count: Count, ctx: &(CursorGroupId, &'a ViewportContext<Cursor>, &'a EditContext), store: &mut Store<I> ) -> UIResult<EditInfo, I>

Search for the n^th result in MoveDirMod direction.