Enum makiko::SessionEvent

#[non_exhaustive]
pub enum SessionEvent {
    StdoutData(Bytes),
    StderrData(Bytes),
    Eof,
    ExitStatus(u32),
    ExitSignal(ExitSignal),
}

An event returned from SessionReceiver.

These are events related to a particular SSH session, they correspond to the requests and data sent by the server.

This enum is marked as #[non_exhaustive], so that we can add new variants without breaking backwards compatibility. It should always be safe to ignore any events that you don’t intend to handle.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

StdoutData(Bytes)

Data from the standard output of the running process.

You should handle this data as a byte stream, the boundaries between consecutive StdoutData events might be arbitrary.

StderrData(Bytes)

Data from the standard error of the running process.

You should handle this data as a byte stream, the boundaries between consecutive StderrData events might be arbitrary.

Eof

End-of-file marker from the running process.

After this, the server should not send more data (both stdout and stderr).

ExitStatus(u32)

The process terminated with given exit status.

ExitSignal(ExitSignal)

The process terminated violently due to a signal.

Trait Implementations

impl Debug for SessionEvent

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

Formats the value using the given formatter.