Struct CustomDocumentStateDTO 

pub struct CustomDocumentStateDTO {
    pub URI: Url,
    pub ViewType: String,
    pub SideCarIdentifier: String,
    pub IsEditable: bool,
    pub BackupIdentifier: Option<String>,
    pub Edits: HashMap<u32, Value>,
}

A struct that holds the state for a document being handled by a custom editor. This is stored in ApplicationState to track the lifecycle of custom documents.

Fields

URI: Url

The URI of the document resource being edited.

ViewType: String

The view type of the custom editor responsible for this document.

SideCarIdentifier: String

The identifier of the sidecar process where the custom editor provider lives.

IsEditable: bool

A flag indicating if the document is currently editable by the user.

BackupIdentifier: Option<String>

An optional identifier for a backup copy of the file’s content.

Edits: HashMap<u32, Value>

A map to store edit history or other versioning information. In a real implementation, this might hold a more structured edit type.

Implementations

impl CustomDocumentStateDTO

pub fn New( URI: Url, ViewType: String, SideCarIdentifier: String, IsEditable: bool, ) -> Result<Self, String>

Creates a new CustomDocumentStateDTO with validation.

Arguments

• URI - The document resource URI
• ViewType - The custom editor type identifier
• SideCarIdentifier - The sidecar process identifier
• IsEditable - Whether the document is user-editable

Returns

Result containing the DTO or an error if validation fails

pub fn AddEdit(&mut self, EditID: u32, EditData: Value) -> Result<(), String>

Adds an edit entry to the edits map with bounds checking.

Arguments

• EditID - The edit identifier
• EditData - The edit data

Returns

Result indicating success or failure if map is full

pub fn ClearEdits(&mut self)

Clears all edit history for this document.

pub fn GetEditCount(&self) -> usize

Returns the count of edits tracked for this document.

Trait Implementations

impl Clone for CustomDocumentStateDTO

fn clone(&self) -> CustomDocumentStateDTO

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomDocumentStateDTO

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CustomDocumentStateDTO

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CustomDocumentStateDTO

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

where __S: Serializer,

Serialize this value into the given Serde serializer.