GPUI.Text.Buffer (gpui v0.2.0)

Copy Markdown View Source

Persistent native Rope text storage with revisioned atomic edits.

GPUI.Text.Buffer requires the gpui_native package because its Rope storage is a native resource. If that package is absent or disabled, operations return {:error, :native_backend_unavailable} rather than calling an unavailable module.

This is a model primitive. It does not represent a file, editor, language, gutter, or workspace. Consumers own those policies and may later attach one or more renderer primitives to the same buffer.

Summary

Types

result(value)
t()

Functions

new(text, opts \\ [])

Creates a native text buffer with one primary selection.

redo(buffer, base_revision)

Redoes one native transaction and creates a new monotonic revision.

snapshot(buffer)

Returns the current text, revision, selections, and history availability.

transact(buffer, transaction)

Atomically applies a transaction based on the current revision.

undo(buffer, base_revision)

Undoes one native transaction and creates a new monotonic revision.

Types

result(value)

@type result(value) :: {:ok, value} | {:error, term()}

t()

@opaque t()

Functions

new(text, opts \\ [])

@spec new(
  String.t(),
  keyword()
) :: result(t())

Creates a native text buffer with one primary selection.

redo(buffer, base_revision)

@spec redo(t(), non_neg_integer()) :: result(GPUI.Text.Snapshot.t())

Redoes one native transaction and creates a new monotonic revision.

snapshot(buffer)

@spec snapshot(t()) :: result(GPUI.Text.Snapshot.t())

Returns the current text, revision, selections, and history availability.

transact(buffer, transaction)

@spec transact(t(), GPUI.Text.Transaction.t()) ::
  result(GPUI.Text.Transaction.Result.t())

Atomically applies a transaction based on the current revision.

undo(buffer, base_revision)

@spec undo(t(), non_neg_integer()) :: result(GPUI.Text.Snapshot.t())

Undoes one native transaction and creates a new monotonic revision.