Enum TextEdit 

pub enum TextEdit {
    Splice {
        at: usize,
        delete: usize,
        insert: String,
    },
    ReplaceText {
        text: String,
    },
}

One edit of plain text. Positions count characters (Unicode scalar values), whatever the document’s own text encoding.

Variants

Splice

Replace delete characters at at with insert: typing is a splice that deletes nothing, Backspace one that inserts nothing.

Fields

at: usize

delete: usize

insert: String

ReplaceText

Replace the whole text with text, written as the smallest splice that turns what the document holds into it, so a collaborator’s concurrent typing elsewhere survives.

Fields

text: String

Implementations

impl TextEdit

pub fn apply_under( &self, doc: &mut AutoCommit, obj: &ExId, ) -> Result<(), ActionError>

Apply this edit to the text object obj of another resource.

Errors

Returns ActionError::Refused when obj is not a text object or the splice reaches past the end of the text; nothing is written.

pub fn apply_to( &self, doc: &mut AutoCommit, obj: &ExId, current: &str, ) -> Result<(), ActionError>

Self::apply_under when the caller already read current, the text obj holds now: a large text is not read a second time.

Errors

As Self::apply_under.

Trait Implementations

impl Action for TextEdit

fn apply(&self, doc: &mut AutoCommit) -> Result<(), ActionError>

A record’s own text, created by the first edit.

fn locus(&self) -> ExecutionLocus

Where this action prefers to run. Defaults to ExecutionLocus::ClientLocal.

fn risk(&self) -> RiskLevel

The consequence class of this particular value — what it would do, not what its type can do. A generic edit action classifies each value (deleting a clip is Destructive, trimming one is not), and the host asks for the same confirmation a declared destructive action gets whenever requires_confirmation holds. Must be a pure function of self. Defaults to Low.

fn inverse_before(&self, doc: &AutoCommit) -> Option<Self>

where Self: Sized,

The document action that undoes this one when apply records an outside consequence in the document (an outbox entry, a filesystem op queue). Computed against the document before this action runs, so a delete can still read the row it removes.

fn inverse_encoded(&self, doc: &AutoCommit) -> Option<EncodedAction>

inverse_before as an encoded action, so the door can undo through apply after the concrete type has been erased.

fn change_kind(&self) -> ChangeKind

Whether this value changes the document’s content or is housekeeping about it (a read marker, a reading position). The executor writes it into the change’s ActionContext, where a workspace activity feed reads it. Must be a pure function of self. Defaults to Content.

fn action_kind(&self) -> ActionKind

What kind of action this value is: whether it only changes the document or also reaches outside it. Must be a pure function of self. An action that records an outside consequence in the document (an outbox entry) is Outside; the default is Undoable.

fn incoming_message(&self) -> bool

Whether this value records a message someone received (a chat post, a delivered mail). The executor marks its change with INCOMING_MESSAGE_FACET. Must be a pure function of self.

fn irreversible(&self) -> bool

Whether this value loses something Undo cannot bring back, beside the document change Undo reverts (an account’s secret every device forgets). See IRREVERSIBLE_TAG. Must be a pure function of self.

fn describe(&self, doc: &AutoCommit) -> Option<Described>

What this value does and to which item, as history records it: a field edit with its values before and after, a verb with its plain arguments, or a group of those. Read from doc as it is before the value applies, on the origin only; replicas replay it with the change. None lets the executor describe the value as the verb its encoded form names (crate::Described::from_encoded).

impl Clone for TextEdit

fn clone(&self) -> TextEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextEdit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TextEdit

fn deserialize<__D>( __deserializer: __D, ) -> Result<TextEdit, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TextEdit

fn eq(&self, other: &TextEdit) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for TextEdit

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TextEdit

impl StructuralPartialEq for TextEdit