Skip to main content

WorkspaceBackend

xtask_todo_lib::devshell::workspace

Trait WorkspaceBackend 

Source 
pub trait WorkspaceBackend {
    // Required methods
    fn logical_cwd(&self) -> String;
    fn set_logical_cwd(
        &mut self,
        path: &str,
    ) -> Result<(), WorkspaceBackendError>;
    fn read_file(
        &mut self,
        path: &str,
    ) -> Result<Vec<u8>, WorkspaceBackendError>;
    fn write_file(
        &mut self,
        path: &str,
        data: &[u8],
    ) -> Result<(), WorkspaceBackendError>;
    fn list_dir(
        &mut self,
        path: &str,
    ) -> Result<Vec<String>, WorkspaceBackendError>;
    fn mkdir(&mut self, path: &str) -> Result<(), WorkspaceBackendError>;
    fn remove(&mut self, path: &str) -> Result<(), WorkspaceBackendError>;
    fn exists(&mut self, path: &str) -> Result<bool, WorkspaceBackendError>;
    fn try_resolve_guest_path(
        &self,
        logical_path: &str,
    ) -> Result<String, WorkspaceBackendError>;
    fn run_rust_tool(
        &mut self,
        vm_session: &mut SessionHolder,
        program: &str,
        args: &[String],
    ) -> Result<ExitStatus, WorkspaceBackendError>;
}
Expand description

Virtual workspace for devshell: Mode S (memory) or Mode P (guest-primary).

Required Methods§

Source

fn logical_cwd(&self) -> String

Source

fn set_logical_cwd(&mut self, path: &str) -> Result<(), WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when path normalization or backend cwd updates fail.

Source

fn read_file(&mut self, path: &str) -> Result<Vec<u8>, WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when the backend cannot read path.

Source

fn write_file( &mut self, path: &str, data: &[u8], ) -> Result<(), WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when the backend cannot write path.

Source

fn list_dir(&mut self, path: &str) -> Result<Vec<String>, WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when directory listing fails.

Source

fn mkdir(&mut self, path: &str) -> Result<(), WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when directory creation fails.

Source

fn remove(&mut self, path: &str) -> Result<(), WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when remove is unsupported or fails.

Source

fn exists(&mut self, path: &str) -> Result<bool, WorkspaceBackendError>

§Errors

Returns WorkspaceBackendError when existence checks fail unexpectedly.

Source

fn try_resolve_guest_path( &self, logical_path: &str, ) -> Result<String, WorkspaceBackendError>

Mode P: logical path → guest absolute path. Mode S: WorkspaceBackendError::ModeSOnly.

§Errors

Returns WorkspaceBackendError::ModeSOnly in Mode S or mapping failures in Mode P.

Source

fn run_rust_tool( &mut self, vm_session: &mut SessionHolder, program: &str, args: &[String], ) -> Result<ExitStatus, WorkspaceBackendError>

Run rustup / cargo (Mode S: sync VFS↔host/VM). Mode P skeleton: WorkspaceBackendError::Unsupported.

§Errors

Returns WorkspaceBackendError when tool execution/sync is unsupported or fails.

Implementors§