Struct TmuxCommandRunner 

pub struct TmuxCommandRunner { /* private fields */ }

runs commands in the background via tmux on a server

Implementations

impl TmuxCommandRunner

pub async fn new( ssh_destination: String, tmux_tmp_dir: String, tmux_socket_filename: String, tmux_session_name: TmuxSessionName, ) -> Result<Self, Error>

create a new command runner and set up necessary tmux session and options on the server side

Errors

this fails if we can not connect to the server and create the tmux session with the required hooks and options

pub async fn run_command( &mut self, command: &str, ) -> Result<CommandResult, Error>

run a new command in the tmux session

Errors

this fails on SSH errors or tmux exit status that is not success

pub async fn close(self) -> Result<(), Error>

this must be awaited at the end, when the command runner is no longer needed. If any commands are still in progress they will not be cleaned up on the server. Await all the futures for commands started on this runner before awaiting this to avoid that issue.

Errors

this fails if we either could not send the quit signal to the background task or if the background task itself exits with an error

Trait Implementations

impl Debug for TmuxCommandRunner

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

Formats the value using the given formatter.