Struct Assist

pub struct Assist {
    pub id: AssistId,
    pub label: Label,
    pub group: Option<GroupLabel>,
    pub target: TextRange,
    pub source_change: Option<SourceChange>,
    pub command: Option<Command>,
}

Fields

id: AssistId

label: Label

Short description of the assist, as shown in the UI.

group: Option<GroupLabel>

target: TextRange

Target ranges are used to sort assists: the smaller the target range, the more specific assist is, and so it should be sorted first.

source_change: Option<SourceChange>

Computing source change sometimes is much more costly then computing the other fields. Additionally, the actual change is not required to show the lightbulb UI, it only is needed when the user tries to apply an assist. So, we compute it lazily: the API allow requesting assists with or without source change. We could (and in fact, used to) distinguish between resolved and unresolved assists at the type level, but this is cumbersome, especially if you want to embed an assist into another data structure, such as a diagnostic.

command: Option<Command>

The command to execute after the assist is applied.

Trait Implementations

impl Clone for Assist

fn clone(&self) -> Assist

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Assist

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

Formats the value using the given formatter.