Struct Shell 

pub struct Shell { /* private fields */ }

Shell that wraps LocalProvider and adds command execution.

Implementations

impl Shell

pub fn new( root: impl Into<PathBuf>, env: HashMap<String, String>, timeout_secs: u64, ) -> Result<Self, VfsError>

Create a new shell rooted at root.

Errors

Propagates errors from LocalProvider::new.

pub fn execute_cmd<'a>( &'a self, cmd: &'a str, args: &'a [String], timeout_override: Option<Duration>, ) -> BoxFuture<'a, Result<ExecuteResponse, VfsError>>

Execute a command with optional timeout, returning truncated output.

Trait Implementations

impl Debug for Shell

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

Formats the value using the given formatter.

impl Vfs for Shell

fn ls( &self, path: &str, opts: LsOptions, ) -> BoxFuture<'_, Result<Vec<DirEntry>, VfsError>>

List directory contents. ls [opts] <path>

fn read(&self, path: &str) -> BoxFuture<'_, Result<FileContent, VfsError>>

Read entire file contents. cat <path>

fn write( &self, path: &str, content: &[u8], ) -> BoxFuture<'_, Result<WriteResult, VfsError>>

Write bytes to a file (creates or overwrites). >

fn edit( &self, path: &str, old: &str, new: &str, ) -> BoxFuture<'_, Result<EditResult, VfsError>>

Edit a file by replacing old with new (first occurrence). sed-like.

fn grep( &self, pattern: &str, opts: GrepOptions, ) -> BoxFuture<'_, Result<Vec<GrepMatch>, VfsError>>

Search file contents. grep [opts] <pattern>

fn glob(&self, pattern: &str) -> BoxFuture<'_, Result<Vec<GlobEntry>, VfsError>>

Glob for file paths matching a pattern.

fn upload( &self, from: &str, to: &str, ) -> BoxFuture<'_, Result<TransferResult, VfsError>>

Upload a file from from (local path) to to (VFS path).

fn download( &self, from: &str, to: &str, ) -> BoxFuture<'_, Result<TransferResult, VfsError>>

Download a file from from (VFS path) to to (local path).

fn pwd(&self) -> BoxFuture<'_, Result<String, VfsError>>

Return the current working directory. pwd

fn cd(&self, path: &str) -> BoxFuture<'_, Result<(), VfsError>>

Change the current working directory. cd <path>

fn rm(&self, path: &str, opts: RmOptions) -> BoxFuture<'_, Result<(), VfsError>>

Remove a file or directory. rm [opts] <path>

fn cp( &self, from: &str, to: &str, opts: CpOptions, ) -> BoxFuture<'_, Result<TransferResult, VfsError>>

Copy from to to. cp [opts] <from> <to>

fn mv_file( &self, from: &str, to: &str, ) -> BoxFuture<'_, Result<TransferResult, VfsError>>

Move / rename from to to. mv <from> <to>

fn capabilities(&self) -> VfsCapabilities

Return the capabilities supported by this provider.

fn provider_name(&self) -> &'static str

Human-readable provider type name (e.g. "LocalProvider", "MemoryProvider").

fn tree( &self, path: &str, opts: TreeOptions, ) -> Pin<Box<dyn Future<Output = Result<TreeEntry, VfsError>> + Send + '_>>

Recursive directory tree. tree [opts] <path>

fn read_range( &self, path: &str, range: ReadRange, ) -> Pin<Box<dyn Future<Output = Result<String, VfsError>> + Send + '_>>

Read a sub-range of a file by line numbers or byte offsets.

fn head( &self, path: &str, opts: HeadTailOptions, ) -> Pin<Box<dyn Future<Output = Result<String, VfsError>> + Send + '_>>

Read the first N lines or bytes. head [opts] <path>

fn tail( &self, path: &str, opts: HeadTailOptions, ) -> Pin<Box<dyn Future<Output = Result<String, VfsError>> + Send + '_>>

Read the last N lines or bytes. tail [opts] <path>

fn stat( &self, path: &str, ) -> Pin<Box<dyn Future<Output = Result<FileInfo, VfsError>> + Send + '_>>

File metadata. stat <path>

fn wc( &self, path: &str, ) -> Pin<Box<dyn Future<Output = Result<WordCount, VfsError>> + Send + '_>>

Line, word, and byte counts. wc <path>

fn du( &self, path: &str, opts: DuOptions, ) -> Pin<Box<dyn Future<Output = Result<DiskUsage, VfsError>> + Send + '_>>

Disk usage. du [opts] <path>

fn append( &self, path: &str, content: &[u8], ) -> Pin<Box<dyn Future<Output = Result<WriteResult, VfsError>> + Send + '_>>

Append bytes to a file (creates if absent). >>

fn mkdir( &self, path: &str, opts: MkdirOptions, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Create a directory. mkdir [opts] <path>

fn touch( &self, path: &str, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Create an empty file or update its timestamp. touch <path>

fn diff( &self, a: &str, b: &str, opts: DiffOptions, ) -> Pin<Box<dyn Future<Output = Result<DiffResult, VfsError>> + Send + '_>>

Compare two files. diff [opts] <a> <b>

fn ln( &self, target: &str, link: &str, symbolic: bool, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Create a link. ln [-s] <target> <link>

fn chmod( &self, path: &str, mode: u32, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Change file permissions. chmod <mode> <path>

fn find( &self, path: &str, opts: FindOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<FindEntry>, VfsError>> + Send + '_>>

Search for files by criteria. find [opts] <path>

fn watch( &self, path: &str, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Begin watching a path for external modifications.

fn check_stale( &self, path: &str, ) -> Pin<Box<dyn Future<Output = Result<(), VfsError>> + Send + '_>>

Check whether a previously-read file has been modified externally.

fn index( &self, path: &str, opts: IndexOptions, ) -> Pin<Box<dyn Future<Output = Result<IndexHandle, VfsError>> + Send + '_>>

Start indexing a directory for semantic search.

fn index_status( &self, index_id: &str, ) -> Pin<Box<dyn Future<Output = Result<IndexStatus, VfsError>> + Send + '_>>

Check the status of an indexing operation.

fn semantic_search( &self, query: &str, opts: SemanticSearchOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<SemanticSearchResult>, VfsError>> + Send + '_>>

Semantic search across indexed content.

fn hybrid_search( &self, query: &str, opts: HybridSearchOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<HybridSearchResult>, VfsError>> + Send + '_>>

Hybrid BM25 + vector search across indexed content.

fn skeleton<'a>( &'a self, path: &'a str, ) -> Pin<Box<dyn Future<Output = Result<String, VfsError>> + Send + 'a>>

Return only the function and method signatures of a source file, stripping all body content.

fn list_communities( &self, ) -> Pin<Box<dyn Future<Output = Result<Vec<CommunityEntry>, VfsError>> + Send + '_>>

List all detected communities with their member counts.

fn community_members( &self, community_id: u64, ) -> Pin<Box<dyn Future<Output = Result<CommunityMembersResult, VfsError>> + Send + '_>>

List the symbol members of a specific community.

fn community_search( &self, query: &str, opts: CommunitySearchOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<CommunitySearchResult>, VfsError>> + Send + '_>>

Search for communities whose member names match query.

fn community_summary( &self, community_id: u64, ) -> Pin<Box<dyn Future<Output = Result<CommunitySummaryResult, VfsError>> + Send + '_>>

Get (or generate) a natural-language summary for a community.

fn mount_info(&self) -> Vec<MountInfo>

Return mount information for this provider.