Struct distant_core::RemoteProcess

pub struct RemoteProcess {
    pub stdin: Option<RemoteStdin>,
    pub stdout: Option<RemoteStdout>,
    pub stderr: Option<RemoteStderr>,
    // some fields omitted
}

Represents a process on a remote machine

Fields

stdin: Option<RemoteStdin>

Sender for stdin

stdout: Option<RemoteStdout>

Receiver for stdout

stderr: Option<RemoteStderr>

Receiver for stderr

Implementations

impl RemoteProcess

pub async fn spawn<T>(
    tenant: String,
    session: Session<T>,
    cmd: String,
    args: Vec<String>
) -> Result<Self, RemoteProcessError> where
    T: DataStream + 'static, 

Spawns the specified process on the remote machine using the given session

pub fn id(&self) -> usize

Returns the id of the running process

pub async fn wait(self) -> Result<(bool, Option<i32>), RemoteProcessError>

Waits for the process to terminate, returning the success status and an optional exit code

pub fn abort(&self)

Aborts the process by forcing its response task to shutdown, which means that a call to wait will return an error. Note that this does not send a kill request, so if you want to be nice you should send the request before aborting.

pub async fn kill(&mut self) -> Result<(), RemoteProcessError>

Submits a kill request for the running process

Trait Implementations

impl Debug for RemoteProcess

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

Formats the value using the given formatter.