Struct CodeAction

pub struct CodeAction {
    pub title: String,
    pub kind: Option<CodeActionKind>,
    pub diagnostics: Option<Vec<Diagnostic>>,
    pub edit: Option<EcoWorkspaceEdit>,
    pub command: Option<Command>,
    pub is_preferred: Option<bool>,
    pub disabled: Option<CodeActionDisabled>,
    pub data: Option<Value>,
}

A code action represents to a single or multiple editor behaviors that can be triggered in a text document.

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<EcoWorkspaceEdit>

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

impl Clone for CodeAction

fn clone(&self) -> CodeAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodeAction

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

Formats the value using the given formatter.

impl Default for CodeAction

fn default() -> CodeAction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CodeAction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CodeAction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CodeAction