Otzel.Op protocol (otzel v0.3.2)

Protocol for delta operations.

An operation represents a single action in a delta. There are three operation types:

Operations implement this protocol to provide common behaviors like merging adjacent operations, calculating size, and splitting operations.

Creating Operations

Use the helper functions in Otzel:

Otzel.insert("Hello")
Otzel.retain(5, %{"bold" => true})
Otzel.delete(3)

Or create structs directly:

%Otzel.Op.Insert{content: "Hello", attrs: nil}
%Otzel.Op.Retain{target: 5, attrs: %{"bold" => true}}
%Otzel.Op.Delete{count: 3}

t()

compose(a, b)

json_encoders()

Attempts to merge two adjacent operations into one.

size(operation)

Returns the size of an operation.

Splits an operation at the given position.

@type t() :: Otzel.Op.Insert.t() | Otzel.Op.Retain.t() | Otzel.Op.Delete.t()

@spec compose(t(), t()) :: {t() | nil, t(), t()}

@spec merge_into(t(), t()) :: t() | nil

Attempts to merge two adjacent operations into one.

Returns the merged operation if the operations can be combined, or nil if they cannot be merged.

Operations can be merged when they are of the same type with compatible attributes.

@spec size(t()) :: non_neg_integer()

Returns the size of an operation.

For inserts and retains, this is the character count of the content. For deletes, this is the number of characters to delete.

@spec take(t(), non_neg_integer()) :: {t(), t() | nil}

Splits an operation at the given position.

Returns a tuple of {taken, rest} where taken is the first count units and rest is the remainder (or nil if nothing remains).

@spec transform(a :: t(), b :: t(), Otzel.priority()) :: {t(), t(), t()}

@spec transform_index(non_neg_integer(), non_neg_integer(), t(), Otzel.priority()) ::
  non_neg_integer()