Struct RemoteFiles 

pub struct RemoteFiles {
    pub conn: String,
    pub home: String,
    pub os: String,
    calls: UnboundedSender<Call>,
    last_used: Mutex<Instant>,
}

One open connection to a host’s helper.

Fields

conn: String

The connection’s canonical name.

home: String

The user’s home directory there (~).

os: String

std::env::consts::OS there.

calls: UnboundedSender<Call>

last_used: Mutex<Instant>

Implementations

impl RemoteFiles

pub async fn over<R, W>( conn: &str, reader: R, writer: W, keep: Box<dyn Any + Send>, ) -> Result<Arc<Self>, RemoteError>

where R: AsyncRead + Unpin + Send + 'static, W: AsyncWrite + Unpin + Send + 'static,

Speak the protocol over reader and writer (an ssh’s stdout and stdin), handshake included. keep lives as long as the connection (the ssh child and its askpass grant).

pub fn is_open(&self) -> bool

Whether the connection is still up.

pub async fn call(&self, req: Request) -> Result<Reply, RemoteError>

One request; a host’s refusal is Err with its kind.

pub async fn stat(&self, path: &str) -> Result<Entry, RemoteError>

pub async fn list(&self, path: &str) -> Result<Vec<Entry>, RemoteError>

Every entry of a directory, a page at a time.

pub async fn read(&self, path: &str, max: u64) -> Result<Vec<u8>, RemoteError>

A whole file of at most max bytes, read in ranges.

pub async fn write(&self, path: &str, data: Vec<u8>) -> Result<(), RemoteError>

Replace a file with data, atomically on the host.

pub async fn append(&self, path: &str, data: Vec<u8>) -> Result<(), RemoteError>

Add data to the end of an existing file (a big upload, in pieces).

pub async fn read_range( &self, path: &str, offset: u64, len: u32, ) -> Result<(Vec<u8>, bool), RemoteError>

One range of a file: up to len bytes from offset, and whether the file ends there.

pub async fn replace(&self, from: &str, to: &str) -> Result<(), RemoteError>

Rename the file from over the file to in one step.

pub async fn realpath(&self, path: &str) -> Result<String, RemoteError>

path with its links and .. resolved.

pub async fn set_meta( &self, path: &str, mode: u32, mtime_ms: i64, ) -> Result<(), RemoteError>

A file’s permission bits (mode, 0 to leave) and modification time (mtime_ms, 0 to leave).

pub async fn sync(&self, path: &str) -> Result<(), RemoteError>

Flush a file’s contents to disk.

pub async fn pane_procs( &self, block_id: &str, session: &str, ) -> Result<PaneFrame, RemoteError>

One pane’s processes on the host (PaneProcs): durable session’s shell, else those marked with block_id.

pub async fn procs( &self, top: u32, filter: &str, ) -> Result<ProcFrame, RemoteError>

The host’s processes for Tower: the top busiest and largest among those matching filter, with totals (agentmux_remote::procs).

pub async fn mkdir(&self, path: &str, parents: bool) -> Result<(), RemoteError>

pub async fn rename(&self, from: &str, to: &str) -> Result<(), RemoteError>

pub async fn delete( &self, path: &str, recursive: bool, ) -> Result<(), RemoteError>

async fn done(&self, req: Request) -> Result<(), RemoteError>

fn idle_for(&self) -> Duration