Documentation Language: Swift

Structure

CommandResult

Output captured from a completed remote command.

struct CommandResult

Overview

CommandResult preserves the remote exit status together with the bytes read from standard output and standard error. Callers can decode those payloads in whatever text or binary form is appropriate for the command they ran.

Topics

Initializers

?
init(exitStatus:output:errorOutput:)

Create a command result from captured remote process state.

Instance Properties

V
errorOutput

Bytes received on the remote standard error stream.

V
exitStatus

Exit status reported by the remote command.

V
output

Bytes received on the remote standard output stream.

Relationships

Conforms To

See Also

Essentials

?
SSHClient

Actor that manages SSH connections, sessions, and local forwards.

S
SSHClientConfiguration

Connection settings used to create an SSHClient.

E
SSHClientError

Errors raised by the high-level SSH client API.