Struct distant_core::RemoteProcess

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

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(
    tenant: impl Into<String>,
    channel: SessionChannel,
    cmd: impl Into<String>,
    args: Vec<String>,
    persist: bool,
    pty: Option<PtySize>
) -> Result<Self, RemoteProcessError>

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 fn origin_id(&self) -> usize

Returns the id of the request that spawned this process

pub async fn status(&self) -> Option<(bool, Option<i32>)>

Checks if the process has completed, returning the exit status if it has, without consuming the process itself. Note that this does not include join errors that can occur when aborting and instead converts any error to a status of false. To acquire the actual error, you must call wait

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 async fn resize(&self, size: PtySize) -> Result<(), RemoteProcessError>

Resizes the pty of the remote process if it is attached to one

pub fn clone_resizer(&self) -> RemoteProcessResizer

Clones a copy of the remote process pty resizer

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

Submits a kill request for the running process

pub fn clone_killer(&self) -> RemoteProcessKiller

Clones a copy of the remote process killer

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.

Trait Implementations

impl Debug for RemoteProcess

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

Formats the value using the given formatter.