vespe 0.1.2

Text as a Canvas for LLM Collaboration and Automation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! This module defines the interface for communicating with a text editor extension.

use anyhow::Result;
use std::path::Path;
use uuid::Uuid;

/// Trait for communicating with a text editor extension.
use std::fmt::Debug;

pub trait EditorCommunicator: Send + Sync + Debug {
    /// Requests the editor to prepare a file for modification.
    /// If the file is open, the editor should save it and ideally lock it to prevent external changes.
    ///
    /// # Arguments
    /// * `file_path` - The absolute path to the file to be modified.
    ///
    /// # Returns
    /// `Ok(Uuid)` with a request ID if the request was successful, `Err` otherwise.
    fn save_and_lock_file(&self, file_path: &Path) -> Result<Uuid>;

    /// Notifies the editor that a file has been modified by the program.
    /// If the file is open, the editor should reload it and unlock it.
    ///
    /// # Arguments
    /// * `file_path` - The absolute path to the file that was modified.
    /// * `request_id` - The ID of the original modification request.
    ///
    /// # Returns
    /// `Ok(())` if the notification was successful, `Err` otherwise.
    fn unlock_and_reload_file(&self, request_id: Uuid) -> Result<()>;
}

pub mod lockfile;