Skip to main content

Transaction

Struct Transaction 

Source
pub struct Transaction { /* private fields */ }
Expand description

A pending change: a Transform plus selection and history intent.

Implementations§

Source§

impl Transaction

Source

pub fn doc(&self) -> &Node

The (in-progress) transformed document.

Source

pub fn transform(&mut self) -> &mut Transform

Mutable access to the underlying transform (apply steps via its helpers, e.g. tx.transform().replace(..)).

Source

pub fn set_selection(&mut self, selection: Selection) -> &mut Self

Explicitly set the selection for the resulting state.

Source

pub fn no_history(&mut self) -> &mut Self

Exclude this transaction from undo history.

Source

pub fn join_history(&mut self) -> &mut Self

Merge this transaction into the previous undo group (e.g. continued typing). Grouping is caller-driven in v0.1.

Source

pub fn doc_changed(&self) -> bool

Whether the document was changed.

Source

pub fn set_history_intent(&mut self, intent: HistoryIntent) -> &mut Self

Tag this transaction so EditorState::apply walks the undo/redo stack instead of applying steps. Used by the History extension’s commands to dispatch through the normal Command/Dispatch pipeline.

Source

pub fn history_intent(&self) -> Option<HistoryIntent>

The history intent on this transaction, if any.

Trait Implementations§

Source§

impl Clone for Transaction

Source§

fn clone(&self) -> Transaction

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 Transaction

Source§

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

Formats the value using the given formatter. Read more

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

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.