Struct StageOperation

pub struct StageOperation {
    pub file_path: String,
    pub language: Option<LanguageName>,
    pub selector: Selector,
    pub content: Option<String>,
}

Stage an operation and see a preview of the changes

The Selector uses a simple but powerful approach: find text with anchor (and optionally end), then perform the specified operation. All operations are AST-aware and respect language syntax.

Basic Usage

Most operations only need an anchor - a short, unique piece of text to locate: {“operation”: “insert_after_node”, “anchor”: “fn main() {” }

Replace_range operations also use end to specify the extent: { “operation”: “replace_range”, “anchor”: “// Start here”, “end”: “// End here” }

To delete a syntax node, use one of the replace operations and omit content

Fields

file_path: String

Path to the source file. If a session has been configured, this can be a relative path to the session root.

language: Option<LanguageName>

Optional language hint. If not provided, language will be detected from file extension.

selector: Selector

How to position the content

content: Option<String>

The new content to insert or replace IMPORTANT TIP: To remove code, use replace and omit content

Trait Implementations

impl Debug for StageOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StageOperation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for StageOperation

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for StageOperation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tool<SemanticEditTools> for StageOperation

fn execute(self, state: &mut SemanticEditTools) -> Result<String>

impl WithExamples for StageOperation

fn examples() -> Vec<Example<Self>>