Struct DocumentStateDTO 

pub struct DocumentStateDTO {
    pub URI: Url,
    pub LanguageIdentifier: String,
    pub Version: i64,
    pub Lines: Vec<String>,
    pub EOL: String,
    pub IsDirty: bool,
    pub Encoding: String,
    pub VersionIdentifier: i64,
}

Represents the complete in-memory state of a single text document.

Fields

URI: Url

The unique resource identifier for this document.

LanguageIdentifier: String

The VS Code language identifier (e.g., “rust”, “typescript”).

Version: i64

The version number, incremented on each change from the client.

Lines: Vec<String>

The content of the document, split into lines.

EOL: String

The detected end-of-line sequence (e.g., \n or \r\n).

IsDirty: bool

A flag indicating if the in-memory version has unsaved changes.

Encoding: String

The detected file encoding (e.g., “utf8”).

VersionIdentifier: i64

An internal version number, used for tracking changes within the host.

Implementations

impl DocumentStateDTO

pub fn Create( URI: Url, LanguageIdentifier: Option<String>, Content: String, ) -> Result<Self, CommonError>

Creates a new DocumentStateDTO from its initial content with validation.

Arguments

• URI - The document resource URI
• LanguageIdentifier - Optional language ID for syntax highlighting
• Content - The initial document content

Returns

Result containing the DTO or an error if validation fails

Errors

Returns CommonError if:

• Language identifier exceeds maximum length
• Document exceeds maximum line count
• Any line exceeds maximum length
• URI is empty

pub fn CreateUnsafe( URI: Url, LanguageIdentifier: String, Lines: Vec<String>, EOL: String, IsDirty: bool, Encoding: String, Version: i64, VersionIdentifier: i64, ) -> Self

Creates a new DocumentStateDTO without validation for internal use. This should only be called with trusted data sources.

pub fn GetText(&self) -> String

Reconstructs the full text content of the document from its lines.

pub fn ToDTO(&self) -> Result<Value, CommonError>

Converts the struct to a serde_json::Value, useful for notifications.

pub fn ApplyChanges( &mut self, NewVersion: i64, ChangesValue: &Value, ) -> Result<(), CommonError>

Applies a set of changes to the document. This can be a full text replacement or a collection of delta changes.

Trait Implementations

impl Clone for DocumentStateDTO

fn clone(&self) -> DocumentStateDTO

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentStateDTO

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DocumentStateDTO

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentStateDTO

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.