Struct DocSync 

pub struct DocSync { /* private fields */ }

Per-actor document-sync state. Pure state + pure methods – no I/O, no ServerHandle dependency. The owning actor sends the LSP params returned by open / take_flush_payload / close over the wire via its writer task.

Mutating methods either update the mirror in place or return the LSP params the caller must ship. record_edit and the flush helpers take &Capabilities so the position-encoding converter knows whether to walk utf-16 columns; pre-this- refactor it pulled the encoding off a ServerHandle borrow.

Implementations

impl DocSync

pub fn new() -> Self

Empty state. Use Self::open to bring a buffer under management.

pub fn open( &mut self, uri: Uri, language_id: impl Into<String>, text: impl Into<String>, ) -> DidOpenTextDocumentParams

Bring a buffer under management with language_id and initial text. Returns the didOpen params the caller ships over the wire. Pure: state mutation + payload construction, no I/O.

pub fn record_edit( &mut self, capabilities: &Capabilities, uri: &Uri, edit: &Edit, ) -> LspResult<()>

Record one committed edit. Updates the mirror, builds the LSP change event for queued send, and bumps the version. Does NOT produce a flush payload – the caller drains via Self::take_flush_payload when ready (debounced or eager). Returns Err only when the URI isn’t open or the edit’s range falls outside the mirror.

pub fn take_flush_payload( &mut self, capabilities: &Capabilities, uri: &Uri, ) -> Option<DidChangeTextDocumentParams>

Drain queued change events into a didChange payload. Returns None when the queue is empty (no-op flush) or the URI isn’t open. Honours the negotiated sync mode:

• Incremental: payload contains the queued events verbatim.
• Full: payload is one synthetic change carrying the entire post-edit mirror text (LSP convention for full sync).
• None: pending is cleared; returns None (caller skips the wire).

pub fn take_flush_all_payloads( &mut self, capabilities: &Capabilities, ) -> Vec<(Uri, DidChangeTextDocumentParams)>

Drain every open doc’s pending changes into per-URI didChange payloads. Used by the actor’s debounce timer + by editor shutdown so the server sees a coherent final state before didClose.

pub fn close( &mut self, capabilities: &Capabilities, uri: &Uri, ) -> Option<ClosePayloads>

Drop the mirror for uri and return the didClose payload (paired with any final flush payload the actor should send first). Returns None when the URI wasn’t open. The actor sends the optional final_changes followed by the close notification so the server’s last view of the doc matches the editor’s.

pub fn is_open(&self, uri: &Uri) -> bool

True iff the URI is currently open under this DocSync.

pub fn version(&self, uri: &Uri) -> Option<i32>

The version we’ll attach to the next didChange for uri if no further edits land before flush. Used by tests + diagnostics gating (drop diagnostics older than our version).

pub fn has_pending(&self, uri: &Uri) -> bool

True iff at least one queued change exists for uri.

Trait Implementations

impl Default for DocSync

fn default() -> Self

Returns the “default value” for a type.