Struct DocumentStatus 

pub struct DocumentStatus { /* private fields */ }

Snapshot of the current document state for frontend polling.

Implementations

impl DocumentStatus

pub fn new( path: Option<PathBuf>, dirty: bool, file_len: usize, line_count: LineCount, line_ending: LineEnding, encoding: DocumentEncoding, preserve_save_error: Option<DocumentEncodingErrorKind>, encoding_origin: DocumentEncodingOrigin, decoding_had_errors: bool, indexing: Option<ByteProgress>, backing: DocumentBacking, ) -> Self

Creates a 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 file_len(&self) -> usize

Returns the current document length in bytes.

pub fn line_count(&self) -> LineCount

Returns the current document line count.

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

Returns the exact line count when it is known.

pub fn display_line_count(&self) -> usize

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

pub fn is_line_count_exact(&self) -> bool

Returns true when the current line count is exact.

pub fn line_ending(&self) -> LineEnding

Returns the currently detected line ending style.

pub fn encoding(&self) -> DocumentEncoding

Returns the current document encoding contract.

pub fn preserve_save_error(&self) -> Option<DocumentEncodingErrorKind>

Returns the typed reason why preserve-save would currently fail, if any.

pub fn can_preserve_save(&self) -> bool

Returns true when preserve-save is currently allowed for this document snapshot.

pub fn encoding_origin(&self) -> DocumentEncodingOrigin

Returns how the current encoding contract was chosen.

pub fn decoding_had_errors(&self) -> bool

Returns true when opening the source required lossy decode replacement.

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

Returns typed indexing progress while background indexing is active.

pub fn is_indexing(&self) -> bool

Returns true when document-local indexing is still running.

pub fn backing(&self) -> DocumentBacking

Returns the current document backing mode.

pub fn has_edit_buffer(&self) -> bool

Returns true when the document currently uses any edit buffer.

pub fn has_rope(&self) -> bool

Returns true when the document is currently backed by a rope.

pub fn has_piece_table(&self) -> bool

Returns true when the document is currently backed by a piece table.

Trait Implementations

impl Clone for DocumentStatus

fn clone(&self) -> DocumentStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentStatus

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

Formats the value using the given formatter.

impl PartialEq for DocumentStatus

fn eq(&self, other: &DocumentStatus) -> 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 DocumentStatus

impl StructuralPartialEq for DocumentStatus