Struct SyncDocument 

pub struct SyncDocument { /* private fields */ }

Available on crate feature concurrency only.

Thread-safe wrapper for EditorDocument

Provides synchronized access to an EditorDocument, allowing multiple threads to safely read and modify the document. Uses RwLock for efficient concurrent reads.

Note: Due to Bump allocator using Cell types, EditorDocument is not Sync. SyncDocument provides thread-safe access through RwLock synchronization. The RwLock ensures that only one thread can write at a time, and the interior mutability of Bump is safe within a single thread.

Implementations

impl SyncDocument

pub fn new(document: EditorDocument) -> Self

Create a new thread-safe document

pub fn from_document(document: EditorDocument) -> Self

Create from an existing document

pub fn read(&self) -> Result<RwLockReadGuard<'_, EditorDocument>>

Get a read-only reference to the document

pub fn write(&self) -> Result<RwLockWriteGuard<'_, EditorDocument>>

Get a mutable reference to the document

pub fn execute_command<C: EditorCommand>( &self, command: C, ) -> Result<CommandResult>

Execute a command atomically

pub fn try_read(&self) -> Option<RwLockReadGuard<'_, EditorDocument>>

Try to get a read-only reference without blocking

pub fn try_write(&self) -> Option<RwLockWriteGuard<'_, EditorDocument>>

Try to get a mutable reference without blocking

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

Get the document text safely

pub fn len(&self) -> Result<usize>

Get document length safely

pub fn is_empty(&self) -> Result<bool>

Check if document is empty safely

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

Get document ID safely

pub fn with_read<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&EditorDocument) -> R,

Perform an operation with read access

pub fn with_write<F, R>(&self, f: F) -> Result<R>

where F: FnOnce(&mut EditorDocument) -> Result<R>,

Perform an operation with write access

pub fn clone_document(&self) -> Result<EditorDocument>

Clone the underlying document

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

Validate the document (basic parsing check)

pub fn validate_comprehensive(&self) -> Result<Vec<ValidationIssue>>

Validate comprehensive (requires mutable access for LazyValidator)

Trait Implementations

impl Clone for SyncDocument

fn clone(&self) -> SyncDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SyncDocument

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

Formats the value using the given formatter.