Skip to main content

DocumentState

Struct DocumentState 

Source
pub struct DocumentState { /* private fields */ }
Expand description

State of a single document.

All fields are private. DocumentTracker::open (via Self::new) establishes the initial state: version starts at 1, disk provenance starts None, and no server is recorded as synced. From there, every mutation goes through a dedicated method (apply_local_edit, commit_reload, set_disk, mark_synced, forget_server) rather than a partial field write, so within a single tracked lifetime version (see Self::version) only increases. This does not cover re-opening: calling DocumentTracker::open again for an already-tracked path unconditionally replaces the entry, resetting version to 1 and clearing synced – see that method’s docs.

The disk provenance invariant: None means the content’s on-disk provenance is unknown (it came from an in-memory open/update call, not a verified disk read), so ensure_open must always re-verify by content compare rather than trusting a stat match. DiskSync’s hand-written PartialEq excludes content_checked_at (see that field’s doc comment), and that exclusion propagates here: two DocumentStates can compare equal via this struct’s derived PartialEq/Eq despite having been disk-verified at different instants. This is intentional – content_checked_at is a debounce timer, not part of a document’s logical state.

Implementations§

Source§

impl DocumentState

Source

pub const fn uri(&self) -> &Uri

Document URI.

Source

pub fn language_id(&self) -> &str

Language identifier.

Source

pub const fn version(&self) -> i32

Document version. Monotonically increasing: every mutation that changes content (apply_local_edit, commit_reload) also bumps this, and never decreases it.

Source

pub fn content(&self) -> &str

Document content.

Source

pub fn synced_version(&self, server: &ServerId) -> Option<i32>

Last document version pushed to server via didOpen/didChange, or None if server has never seen this document.

A single document can be synced to multiple servers (e.g. hover routed to one server, diagnostics to another for the same language), each needing its own didOpen/didChange history – a server absent from this map has never seen the document and must receive didOpen, not didChange, on its next ensure_open call.

Trait Implementations§

Source§

impl Clone for DocumentState

Source§

fn clone(&self) -> DocumentState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DocumentState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DocumentState

Source§

impl PartialEq for DocumentState

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DocumentState

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more