Struct DocumentSessionStatus 

pub struct DocumentSessionStatus { /* private fields */ }

Snapshot of a DocumentSession state for frontend polling.

Implementations

impl DocumentSessionStatus

pub fn generation(&self) -> u64

Returns the session generation counter.

pub fn document(&self) -> &DocumentStatus

Returns the document status snapshot.

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

Returns the current document path, if one is set.

pub fn is_dirty(&self) -> bool

Returns true when the document has unsaved changes.

pub fn line_count(&self) -> LineCount

Returns the current document line count.

pub fn display_line_count(&self) -> usize

Returns the best-effort line count for viewport sizing and scrolling.

pub fn exact_line_count(&self) -> Option<usize>

Returns the exact document line count when it is known.

pub fn is_line_count_exact(&self) -> bool

Returns true when the current line count is exact.

pub fn file_len(&self) -> usize

Returns the current document length in bytes.

pub fn line_ending(&self) -> LineEnding

Returns the currently detected line ending style.

pub fn backing(&self) -> DocumentBacking

Returns the current document backing mode.

pub fn has_edit_buffer(&self) -> bool

Returns true when the document currently has a mutable edit buffer.

pub fn has_rope(&self) -> bool

Returns true when the document is currently rope-backed.

pub fn has_piece_table(&self) -> bool

Returns true when the document is currently piece-table-backed.

pub fn indexing_state(&self) -> Option<ByteProgress>

Returns typed indexing progress while document-local indexing is active.

pub fn is_indexing(&self) -> bool

Returns true while document-local indexing is still running.

pub fn background_activity(&self) -> &BackgroundActivity

Returns the current background activity.

pub fn background_issue(&self) -> Option<&BackgroundIssue>

Returns the most recent background open/save problem, if one is being retained.

pub fn close_pending(&self) -> bool

Returns true when close_file() was requested while a background job was active and the actual close is deferred until that job finishes.

pub fn loading_state(&self) -> Option<&FileProgress>

Returns typed loading progress when a background open is active.

pub fn loading_phase(&self) -> Option<LoadPhase>

Returns the current loading phase when a background open is active.

pub fn save_state(&self) -> Option<&FileProgress>

Returns typed save progress when a background save is active.

pub fn is_busy(&self) -> bool

Returns true while any background open/save job is active.

pub fn is_loading(&self) -> bool

Returns true while a background load is in progress.

pub fn is_saving(&self) -> bool

Returns true while a background save is in progress.

Trait Implementations

impl Clone for DocumentSessionStatus

fn clone(&self) -> DocumentSessionStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentSessionStatus

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

Formats the value using the given formatter.

impl PartialEq for DocumentSessionStatus

fn eq(&self, other: &DocumentSessionStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for DocumentSessionStatus

impl StructuralPartialEq for DocumentSessionStatus