Crate text_document 

text-document

A rich text document model for Rust.

Provides a TextDocument as the main entry point and TextCursor for cursor-based editing, inspired by Qt’s QTextDocument/QTextCursor API.

use text_document::{TextDocument, MoveMode, MoveOperation};

let doc = TextDocument::new();
doc.set_plain_text("Hello world").unwrap();

let cursor = doc.cursor();
cursor.move_position(MoveOperation::EndOfWord, MoveMode::KeepAnchor, 1);
cursor.insert_text("Goodbye").unwrap(); // replaces "Hello"

// Multiple cursors on the same document
let c1 = doc.cursor();
let c2 = doc.cursor_at(5);
c1.insert_text("A").unwrap();
// c2's position is automatically adjusted

doc.undo().unwrap();

Modules

matching

The matcher, as a pure function over &str — no document, no store, no threads.

Structs

BatchDocument

A headless document: no thread, no view, no cursor. See the module docs.

BlockFormat

Block (paragraph) formatting. All fields are optional.

BlockInfo

Info about a block at a given position.

BlockSnapshot

All layout-relevant data for one block, captured atomically.

CellFormat

Cell-level formatting.

CellRange

A rectangular range of cells within a single table (inclusive bounds).

CellSnapshot

Snapshot of one table cell including its block content.

Color

An RGBA color value. Each component is 0–255.

DjotExportOptions

Selects which optional block attributes the djot exporter emits as {key=value} block attributes. A disabled attribute is omitted from the output even when the model carries a value for it.

DjotImportOptions

Selects which optional block attributes the djot importer applies to the document model. An attribute present in the source but disabled here is parsed and discarded, exactly like an unrepresentable construct.

DocumentFragment

A piece of rich text that can be inserted into a TextDocument.

DocumentStats

Document-level statistics. O(1) cached.

DocxExportOptions

Page geometry + base typography overrides for a DOCX export. Every field is optional; the Default is “no overrides” — exactly what plain to_docx produces.

DocxExportResult

Result of a DOCX export (to_docx).

EpubExportOptions

Book-level metadata for an EPUB export. Every field is required by the container format in some form, so unlike super::docx_options::DocxExportOptions there is no “no overrides” default that matches an unconfigured EPUB — Default instead picks the most reasonable placeholders.

EpubExportResult

Result of an EPUB export (to_epub).

FindMatch

A single search match.

FindOptions

Options for find / find_all / replace operations.

FlowSnapshot

Consistent snapshot of the entire document flow, captured in a single lock acquisition.

FrameFormat

Frame formatting. All fields are optional.

FrameRef

Reference to the frame that immediately encloses the cursor’s block. depth is the nesting level (1 for a direct child of the root). is_blockquote is true iff fmt_is_blockquote is Some(true).

FrameSnapshot

Snapshot of a sub-frame and its contents.

HighlightContext

Context passed to SyntaxHighlighter::highlight_block.

HighlightFormat

Formatting applied by a syntax highlighter to a text range.

HighlightMask

Which highlight sessions a particular view renders.

HighlightSpan

A single highlight span within a block.

HtmlImportResult

Result of an HTML import (set_html).

ListFormat

List formatting. All fields are optional: None means “not set — don’t change this property.”

ListInfo

List membership and marker information for a block.

MarkdownImportResult

Result of a Markdown import (set_markdown).

Operation

A handle to a running long operation (Markdown/HTML import, DOCX export).

PaintHighlightSpan

A resolved paint-only highlight span for one character range of a block.

PdfExportOptions

Page geometry + typography + embedded font bytes for a PDF export.

PdfExportResult

Result of a PDF export (to_pdf).

RangeHighlight

One highlight range carried by a range session, in absolute document char offsets — the same coordinate space crate::FindMatch and replace report in.

ReplaceOptions

Options for a replace: how to find the text, and what the replacement wears where it overwrites formatted prose.

ReplaceRange

One range to replace, with its own replacement text.

SessionId

Identifies one registered highlight session (see crate::TextDocument::add_syntax_session / crate::TextDocument::add_range_session).

Subscription

Handle to a document event subscription.

TableCellContext

Snapshot-friendly reference to a table cell (plain IDs, no live handles).

TableCellRef

Reference to a table cell that contains a block.

TableFormat

Table-level formatting.

TableSnapshot

Consistent snapshot of a table’s structure and all cell content.

TextBlock

A lightweight, read-only handle to a single block (paragraph).

TextCursor

A cursor into a TextDocument.

TextDocument

A rich text document.

TextFormat

Character/text formatting. All fields are optional: None means “not set — inherit from the block’s default or the document’s default.”

TextFrame

A read-only handle to a frame in the document.

TextList

A read-only handle to a list in the document.

TextTable

A read-only handle to a table in the document.

TextTableCell

A read-only handle to a single cell within a table.

WordCharCounts

The three counts a caller might display. All three are always computed — “characters with spaces” vs “without” is a display choice, not a separate counting mode.

Enums

Alignment

CellVerticalAlignment

Vertical alignment within a table cell.

CharVerticalAlignment

CountMethod

How words are delimited. Characters are always counted the same way (Unicode scalar values), independent of this choice — see WordCharCounts.

DocumentError

Errors returned by the public text-document API.

DocumentEvent

Events emitted by a TextDocument.

FlowElement

An element in the document’s visual flow.

FlowElementSnapshot

Snapshot of one flow element.

FormatChangeKind

What kind of formatting changed.

FragmentContent

A contiguous run of content with uniform formatting within a block.

FramePosition

InlineContent

Content type for an inline segment: text, image, or empty.

ListStyle

MarkerType

MoveMode

Controls whether a movement collapses or extends the selection.

MoveOperation

Semantic cursor movement operations.

ReplaceFormatPolicy

What the replacement text wears when it overwrites formatted text.

ResourceType

SelectionKind

Describes what kind of selection the cursor currently has.

SelectionType

Quick-select a region around the cursor.

TextDirection

UnderlineStyle

WrapMode

Constants

TABLE_ANCHOR

The U+FFFC OBJECT REPLACEMENT CHARACTER that stands for a table in the document’s text.

Traits

SyntaxHighlighter

A user-implemented syntax highlighter that applies visual-only formatting.

Functions

count

Count words and characters in already-extracted plain text.

count_djot

Extract prose from Djot source, then count. The two-step (strip then count) is kept deliberately simple: djot_to_plain_text carries a pinned contract (table-anchor sentinel, single-\n block joins) and fusing the parse-and-count into one AST walk is the easiest way to accidentally create a third, silently-diverging “what is the text”.

djot_to_plain_text

The prose of a Djot document, with no entities, no store, and no threads.

Type Aliases

Result

Result alias used throughout the public API.