Skip to main content

Workspace

steer_workspace

Trait Workspace 

Source 
pub trait Workspace:
    Send
    + Sync
    + Debug {
    // Required methods
    fn environment<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = Result<EnvironmentInfo>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn metadata(&self) -> WorkspaceMetadata;
    fn invalidate_environment_cache<'life0, 'async_trait>(
        &'life0 self,
    ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait;
    fn list_files<'life0, 'life1, 'async_trait>(
        &'life0 self,
        query: Option<&'life1 str>,
        max_results: Option<usize>,
    ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn working_directory(&self) -> &Path;
    fn read_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: ReadFileRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<FileContentResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn list_directory<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: ListDirectoryRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<FileListResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn glob<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: GlobRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<GlobResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn grep<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: GrepRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<SearchResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn astgrep<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: AstGrepRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<SearchResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn apply_edits<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: ApplyEditsRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<EditResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
    fn write_file<'life0, 'life1, 'async_trait>(
        &'life0 self,
        request: WriteFileRequest,
        ctx: &'life1 WorkspaceOpContext,
    ) -> Pin<Box<dyn Future<Output = Result<EditResult>> + Send + 'async_trait>>
       where Self: 'async_trait,
             'life0: 'async_trait,
             'life1: 'async_trait;
}
Expand description

Core workspace abstraction for environment information and file operations

Required Methods§

Source

fn environment<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<EnvironmentInfo>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Get environment information for this workspace

Source

fn metadata(&self) -> WorkspaceMetadata

Get workspace metadata

Source

fn invalidate_environment_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Invalidate cached environment information (force refresh on next call)

Source

fn list_files<'life0, 'life1, 'async_trait>( &'life0 self, query: Option<&'life1 str>, max_results: Option<usize>, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List files in the workspace for fuzzy finding Returns workspace-relative paths, filtered by optional query

Source

fn working_directory(&self) -> &Path

Get the working directory for this workspace

Source

fn read_file<'life0, 'life1, 'async_trait>( &'life0 self, request: ReadFileRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<FileContentResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read file contents with optional offset/limit.

Source

fn list_directory<'life0, 'life1, 'async_trait>( &'life0 self, request: ListDirectoryRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<FileListResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List a directory (similar to ls).

Source

fn glob<'life0, 'life1, 'async_trait>( &'life0 self, request: GlobRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<GlobResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Apply glob patterns.

Source

fn grep<'life0, 'life1, 'async_trait>( &'life0 self, request: GrepRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<SearchResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Text search (grep-style).

Source

fn astgrep<'life0, 'life1, 'async_trait>( &'life0 self, request: AstGrepRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<SearchResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

AST search (astgrep-style).

Source

fn apply_edits<'life0, 'life1, 'async_trait>( &'life0 self, request: ApplyEditsRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<EditResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Apply one or more edits to a file.

Source

fn write_file<'life0, 'life1, 'async_trait>( &'life0 self, request: WriteFileRequest, ctx: &'life1 WorkspaceOpContext, ) -> Pin<Box<dyn Future<Output = Result<EditResult>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Write/replace entire file content.

Implementors§