Struct DocumentSnapshot 

pub struct DocumentSnapshot {
    pub id: DocumentId,
    pub version: u64,
    pub text_version: u64,
    pub buffer: Buffer,
    pub path: Option<Arc<PathBuf>>,
    pub dirty: bool,
    pub selections: Arc<SelectionSet>,
}

One immutable snapshot of a document. Cheap to clone (every non-trivial field is already Arc-shareable internally; Buffer wraps a ropey::Rope whose interior is a B-tree of Arcs, so cloning is O(log n) with no heap allocation in the common case).

Fields

id: DocumentId

version: u64

Bumps on any commit (edits, undo, redo, set_path, mark_clean).

text_version: u64

Bumps only on text-mutating commits. Used by the syntax cache to decide whether to reparse.

buffer: Buffer

path: Option<Arc<PathBuf>>

Arc<PathBuf> so cloning a snapshot doesn’t clone the path string. None means an unsaved buffer (*scratch*-style).

dirty: bool

True iff the buffer differs from its on-disk state. Tracked by the document’s clean-position bookkeeping; the snapshot just reflects the current value.

selections: Arc<SelectionSet>

Arc<SelectionSet> so cloning a snapshot doesn’t clone the selection vector. v1 single-cursor: this is always one charwise selection; multi-cursor support folds in here when it lands.

Implementations

impl DocumentSnapshot

pub fn path(&self) -> Option<&Path>

Convenience: borrow the path slice if set.

pub fn text(&self) -> String

Convenience: render the buffer to a String. The renderer’s hot path should prefer [Buffer::as_string] on &self.buffer directly; this is for tests / debug output.

Trait Implementations

impl Clone for DocumentSnapshot

fn clone(&self) -> DocumentSnapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSnapshot

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

Formats the value using the given formatter.

impl Default for DocumentSnapshot

fn default() -> DocumentSnapshot

Returns the “default value” for a type.