Struct TextDocument 

pub struct TextDocument { /* private fields */ }

A rich text document.

Owns the backend (database, event hub, undo/redo manager) and provides document-level operations. All cursor-based editing goes through TextCursor, obtained via cursor() or cursor_at().

Internally uses Arc<Mutex<...>> so that multiple TextCursors can coexist and edit concurrently. Cloning a TextDocument creates a new handle to the same underlying document (like Qt’s implicit sharing).

Implementations

impl TextDocument

pub fn new() -> Self

Create a new, empty document.

Panics

Panics if the database context cannot be created (e.g. filesystem error). Use TextDocument::try_new for a fallible alternative.

pub fn try_new() -> Result<Self>

Create a new, empty document, returning an error on failure.

pub fn set_plain_text(&self, text: &str) -> Result<()>

Replace the entire document with plain text. Clears undo history.

pub fn to_plain_text(&self) -> Result<String>

Export the entire document as plain text.

pub fn set_markdown( &self, markdown: &str, ) -> Result<Operation<MarkdownImportResult>>

Replace the entire document with Markdown. Clears undo history.

This is a long operation. Returns a typed Operation handle.

pub fn to_markdown(&self) -> Result<String>

Export the entire document as Markdown.

pub fn set_html(&self, html: &str) -> Result<Operation<HtmlImportResult>>

Replace the entire document with HTML. Clears undo history.

This is a long operation. Returns a typed Operation handle.

pub fn to_html(&self) -> Result<String>

Export the entire document as HTML.

pub fn to_latex( &self, document_class: &str, include_preamble: bool, ) -> Result<String>

Export the entire document as LaTeX.

pub fn to_docx(&self, output_path: &str) -> Result<Operation<DocxExportResult>>

Export the entire document as DOCX to a file path.

This is a long operation. Returns a typed Operation handle.

pub fn clear(&self) -> Result<()>

Clear all document content and reset to an empty state.

pub fn cursor(&self) -> TextCursor

Create a cursor at position 0.

pub fn cursor_at(&self, position: usize) -> TextCursor

Create a cursor at the given position.

pub fn stats(&self) -> DocumentStats

Get document statistics. O(1) — reads cached values.

pub fn character_count(&self) -> usize

Get the total character count. O(1) — reads cached value.

pub fn block_count(&self) -> usize

Get the number of blocks (paragraphs). O(1) — reads cached value.

pub fn is_empty(&self) -> bool

Returns true if the document has no text content.

pub fn text_at(&self, position: usize, length: usize) -> Result<String>

Get text at a position for a given length.

pub fn block_at(&self, position: usize) -> Result<BlockInfo>

Get info about the block at a position. O(log n).

pub fn block_format_at(&self, position: usize) -> Result<BlockFormat>

Get the block format at a position.

pub fn find( &self, query: &str, from: usize, options: &FindOptions, ) -> Result<Option<FindMatch>>

Find the next (or previous) occurrence. Returns None if not found.

pub fn find_all( &self, query: &str, options: &FindOptions, ) -> Result<Vec<FindMatch>>

Find all occurrences.

pub fn replace_text( &self, query: &str, replacement: &str, replace_all: bool, options: &FindOptions, ) -> Result<usize>

Replace occurrences. Returns the number of replacements. Undoable.

pub fn add_resource( &self, resource_type: ResourceType, name: &str, mime_type: &str, data: &[u8], ) -> Result<()>

Add a resource (image, stylesheet) to the document.

pub fn resource(&self, name: &str) -> Result<Option<Vec<u8>>>

Get a resource by name. Returns None if not found.

Uses an internal cache to avoid scanning all resources on repeated lookups.

pub fn undo(&self) -> Result<()>

Undo the last operation.

pub fn redo(&self) -> Result<()>

Redo the last undone operation.

pub fn can_undo(&self) -> bool

Returns true if there are operations that can be undone.

pub fn can_redo(&self) -> bool

Returns true if there are operations that can be redone.

pub fn clear_undo_redo(&self)

Clear all undo/redo history.

pub fn is_modified(&self) -> bool

Returns true if the document has been modified since creation or last reset.

pub fn set_modified(&self, modified: bool)

Set or clear the modified flag.

pub fn title(&self) -> String

Get the document title.

pub fn set_title(&self, title: &str) -> Result<()>

Set the document title.

pub fn text_direction(&self) -> TextDirection

Get the text direction.

pub fn set_text_direction(&self, direction: TextDirection) -> Result<()>

Set the text direction.

pub fn default_wrap_mode(&self) -> WrapMode

Get the default wrap mode.

pub fn set_default_wrap_mode(&self, mode: WrapMode) -> Result<()>

Set the default wrap mode.

pub fn on_change<F>(&self, callback: F) -> Subscription

where F: Fn(DocumentEvent) + Send + Sync + 'static,

Subscribe to document events via callback.

Callbacks are invoked outside the document lock (after the editing operation completes and the lock is released). It is safe to call TextDocument or TextCursor methods from within the callback without risk of deadlock. However, keep callbacks lightweight — they run synchronously on the calling thread and block the caller until they return.

Drop the returned Subscription to unsubscribe.

Breaking change (v0.0.6)

The callback bound changed from Send to Send + Sync in v0.0.6 to support Arc-based dispatch. Callbacks that capture non-Sync types (e.g., Rc<T>, Cell<T>) must be wrapped in a Mutex.

pub fn poll_events(&self) -> Vec<DocumentEvent>

Return events accumulated since the last poll_events() call.

This delivery path is independent of callback dispatch via on_change — using both simultaneously is safe and each path sees every event exactly once.

Trait Implementations

impl Clone for TextDocument

fn clone(&self) -> TextDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TextDocument

fn default() -> Self

Returns the “default value” for a type.