Struct WorkspaceEdit

pub struct WorkspaceEdit {
    pub changes: Option<HashMap<Url, Vec<TextEdit>>>,
    pub document_changes: Option<DocumentChanges>,
    pub change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>,
}

A workspace edit represents changes to many resources managed in the workspace. The edit should either provide changes or documentChanges. If the client can handle versioned document edits and if documentChanges are present, the latter are preferred over changes.

Fields

changes: Option<HashMap<Url, Vec<TextEdit>>>

Holds changes to existing resources.

document_changes: Option<DocumentChanges>

Depending on the client capability workspace.workspaceEdit.resourceOperations document changes are either an array of TextDocumentEdits to express changes to n different text documents where each text document edit addresses a specific version of a text document. Or it can contain above TextDocumentEdits mixed with create, rename and delete file / folder operations.

Whether a client supports versioned document edits is expressed via workspace.workspaceEdit.documentChanges client capability.

If a client neither supports documentChanges nor workspace.workspaceEdit.resourceOperations then only plain TextEdits using the changes property are supported.

change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>

A map of change annotations that can be referenced in AnnotatedTextEdits or create, rename and delete file / folder operations.

Whether clients honor this property depends on the client capability workspace.changeAnnotationSupport.

@since 3.16.0

Implementations

impl WorkspaceEdit

pub fn new(changes: HashMap<Url, Vec<TextEdit>>) -> WorkspaceEdit

Trait Implementations

impl Clone for WorkspaceEdit

fn clone(&self) -> WorkspaceEdit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceEdit

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

Formats the value using the given formatter.

impl Default for WorkspaceEdit

fn default() -> WorkspaceEdit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkspaceEdit

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WorkspaceEdit

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WorkspaceEdit

impl StructuralPartialEq for WorkspaceEdit