Struct EditorState 

pub struct EditorState { /* private fields */ }

The complete editor state.

Implementations

impl EditorState

pub fn new(doc: Node, schema: Schema) -> Self

A fresh state for doc, caret at the document start.

pub fn with_plugins(doc: Node, schema: Schema, plugins: PluginSet) -> Self

A fresh state pre-loaded with a PluginSet. Each plugin’s Plugin::init is called with the (partially-initialised) state, so plugins can derive their initial value from the doc.

pub fn with_history(self, history: History) -> Self

Use a custom history depth.

pub fn plugin<P: Plugin>(&self, _key: PluginKey<P>) -> Option<&P::State>

Borrow this state’s plugin value (returns None if no plugin of type P was registered when the state was built).

pub fn doc(&self) -> &Node

The current document.

pub fn selection(&self) -> Selection

The current selection.

pub fn schema(&self) -> &Schema

The schema.

pub fn history(&self) -> &History

Undoable / redoable depth.

pub fn tr(&self) -> Transaction

Begin a transaction from the current state.

pub fn apply(&self, tx: Transaction) -> EditorState

Apply tx, returning the next state. Selection is mapped through the transaction unless the transaction set one explicitly; a changing, history-tracked transaction records an undo group. Transactions carrying a HistoryIntent resolve to undo / redo on this state (and never push another history entry); if the stack is empty the current state is returned unchanged.

pub fn undo(&self) -> Option<EditorState>

Undo the most recent group, or None if nothing to undo.

pub fn redo(&self) -> Option<EditorState>

Redo the most recently undone group, or None.

Trait Implementations

impl Clone for EditorState

fn clone(&self) -> EditorState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EditorState

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

Formats the value using the given formatter.