Skip to main content

EditorState

Struct EditorState 

Source
pub struct EditorState(/* private fields */);
Expand description

An editor state: the node map and the selection. A handle; cloning it shares the same state. Once read-only (committed or parsed), nothing changes it: an update works on a clone whose node map shares the nodes, and a node is copied before its first change (getWritable).

Implementations§

Source§

impl EditorState

Source

pub fn is_empty(&self) -> bool

isEmpty(): nothing but the root, and no selection.

Source

pub fn selection(&self) -> Option<SelectionRef>

The state’s selection (editorState._selection).

Source

pub fn clone_with_selection( &self, selection: Option<Option<SelectionRef>>, ) -> EditorState

clone(selection): a read-only state with the same nodes, and selection (None is JS’s undefined, this state’s selection; Some(None) is null). It is parsed when this one is, so setEditorState(parsed.clone(null)) still runs transforms on it. (Clone::clone shares this state itself.)

Source

pub fn ptr_eq(&self, other: &EditorState) -> bool

Whether self and other are the same state.

Source

pub fn read<R>(&self, f: impl FnOnce() -> R) -> R

read(callbackFn): runs f with this state active, read-only.

Source

pub fn to_json(&self, compact: bool) -> Value

toJSON(compact): the document’s JSON, in the compact form or the legacy form that writes every property. to_json(false).to_string() is JSON.stringify(editorState.toJSON()).

Trait Implementations§

Source§

impl Clone for EditorState

Source§

fn clone(&self) -> Self

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 EditorState

Source§

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

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

impl SignalValue for EditorState

Source§

fn is_same(&self, other: &Self) -> bool

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.