Struct lsp_types::CodeAction
source · [−]pub struct CodeAction {
pub title: String,
pub kind: Option<CodeActionKind>,
pub diagnostics: Option<Vec<Diagnostic>>,
pub edit: Option<WorkspaceEdit>,
pub command: Option<Command>,
pub is_preferred: Option<bool>,
pub disabled: Option<CodeActionDisabled>,
pub data: Option<Value>,
}
Fields
title: String
A short, human-readable, title for this code action.
kind: Option<CodeActionKind>
The kind of the code action. Used to filter code actions.
diagnostics: Option<Vec<Diagnostic>>
The diagnostics that this code action resolves.
edit: Option<WorkspaceEdit>
The workspace edit this code action performs.
command: Option<Command>
A command this code action executes. If a code action provides an edit and a command, first the edit is executed and then the command.
is_preferred: Option<bool>
Marks this as a preferred action. Preferred actions are used by the auto fix
command and can be targeted
by keybindings.
A quick fix should be marked preferred if it properly addresses the underlying error.
A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
since 3.15.0
disabled: Option<CodeActionDisabled>
Marks that the code action cannot currently be applied.
Clients should follow the following guidelines regarding disabled code actions:
-
Disabled code actions are not shown in automatic lightbulb code action menu.
-
Disabled actions are shown as faded out in the code action menu when the user request a more specific type of code action, such as refactorings.
-
If the user has a keybinding that auto applies a code action and only a disabled code actions are returned, the client should show the user an error message with
reason
in the editor.
since 3.16.0
data: Option<Value>
A data entry field that is preserved on a code action between
a textDocument/codeAction
and a codeAction/resolve
request.
since 3.16.0
Trait Implementations
sourceimpl Clone for CodeAction
impl Clone for CodeAction
sourcefn clone(&self) -> CodeAction
fn clone(&self) -> CodeAction
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 CodeAction
impl Debug for CodeAction
sourceimpl Default for CodeAction
impl Default for CodeAction
sourcefn default() -> CodeAction
fn default() -> CodeAction
Returns the “default value” for a type. Read more
sourceimpl<'de> Deserialize<'de> for CodeAction
impl<'de> Deserialize<'de> for CodeAction
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 From<CodeAction> for CodeActionOrCommand
impl From<CodeAction> for CodeActionOrCommand
sourcefn from(action: CodeAction) -> Self
fn from(action: CodeAction) -> Self
Converts to this type from the input type.
sourceimpl PartialEq<CodeAction> for CodeAction
impl PartialEq<CodeAction> for CodeAction
sourcefn eq(&self, other: &CodeAction) -> bool
fn eq(&self, other: &CodeAction) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CodeAction) -> bool
fn ne(&self, other: &CodeAction) -> bool
This method tests for !=
.
sourceimpl Serialize for CodeAction
impl Serialize for CodeAction
impl StructuralPartialEq for CodeAction
Auto Trait Implementations
impl RefUnwindSafe for CodeAction
impl Send for CodeAction
impl Sync for CodeAction
impl Unpin for CodeAction
impl UnwindSafe for CodeAction
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
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.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more