Struct lsp_types::WorkspaceEdit
source · [−]pub struct WorkspaceEdit {
pub changes: Option<HashMap<Url, Vec<TextEdit>>>,
pub document_changes: Option<DocumentChanges>,
pub change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>,
}
Expand description
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 TextDocumentEdit
s 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 TextDocumentEdit
s 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 TextEdit
s using the changes
property are supported.
change_annotations: Option<HashMap<ChangeAnnotationIdentifier, ChangeAnnotation>>
A map of change annotations that can be referenced in
AnnotatedTextEdit
s 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
sourceimpl WorkspaceEdit
impl WorkspaceEdit
Trait Implementations
sourceimpl Clone for WorkspaceEdit
impl Clone for WorkspaceEdit
sourcefn clone(&self) -> WorkspaceEdit
fn clone(&self) -> WorkspaceEdit
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for WorkspaceEdit
impl Debug for WorkspaceEdit
sourceimpl Default for WorkspaceEdit
impl Default for WorkspaceEdit
sourcefn default() -> WorkspaceEdit
fn default() -> WorkspaceEdit
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for WorkspaceEdit
impl<'de> Deserialize<'de> for WorkspaceEdit
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<WorkspaceEdit> for WorkspaceEdit
impl PartialEq<WorkspaceEdit> for WorkspaceEdit
sourcefn eq(&self, other: &WorkspaceEdit) -> bool
fn eq(&self, other: &WorkspaceEdit) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &WorkspaceEdit) -> bool
fn ne(&self, other: &WorkspaceEdit) -> bool
This method tests for !=
.
sourceimpl Serialize for WorkspaceEdit
impl Serialize for WorkspaceEdit
impl Eq for WorkspaceEdit
impl StructuralEq for WorkspaceEdit
impl StructuralPartialEq for WorkspaceEdit
Auto Trait Implementations
impl RefUnwindSafe for WorkspaceEdit
impl Send for WorkspaceEdit
impl Sync for WorkspaceEdit
impl Unpin for WorkspaceEdit
impl UnwindSafe for WorkspaceEdit
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more