Enum ChannelMsg 

#[non_exhaustive]
pub enum ChannelMsg {
    Open {
        id: ChannelId,
        max_packet_size: u32,
        window_size: u32,
    },
    Data {
        data: CryptoVec,
    },
    ExtendedData {
        data: CryptoVec,
        ext: u32,
    },
    Eof,
    Close,
    RequestPty {
        want_reply: bool,
        term: String,
        col_width: u32,
        row_height: u32,
        pix_width: u32,
        pix_height: u32,
        terminal_modes: Vec<(Pty, u32)>,
    },
    RequestShell {
        want_reply: bool,
    },
    Exec {
        want_reply: bool,
        command: Vec<u8>,
    },
    Signal {
        signal: Sig,
    },
    RequestSubsystem {
        want_reply: bool,
        name: String,
    },
    RequestX11 {
        want_reply: bool,
        single_connection: bool,
        x11_authentication_protocol: String,
        x11_authentication_cookie: String,
        x11_screen_number: u32,
    },
    SetEnv {
        want_reply: bool,
        variable_name: String,
        variable_value: String,
    },
    WindowChange {
        col_width: u32,
        row_height: u32,
        pix_width: u32,
        pix_height: u32,
    },
    AgentForward {
        want_reply: bool,
    },
    XonXoff {
        client_can_do: bool,
    },
    ExitStatus {
        exit_status: u32,
    },
    ExitSignal {
        signal_name: Sig,
        core_dumped: bool,
        error_message: String,
        lang_tag: String,
    },
    WindowAdjusted {
        new_size: u32,
    },
    Success,
    Failure,
    OpenFailure(ChannelOpenFailure),
}

Possible messages that Channel::wait can receive.

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.

Open

Fields

id: ChannelId

max_packet_size: u32

window_size: u32

Data

Fields

data: CryptoVec

ExtendedData

Fields

data: CryptoVec

ext: u32

Eof

Close

RequestPty

(client only)

Fields

want_reply: bool

term: String

col_width: u32

row_height: u32

pix_width: u32

pix_height: u32

terminal_modes: Vec<(Pty, u32)>

RequestShell

(client only)

Fields

want_reply: bool

Exec

(client only)

Fields

want_reply: bool

command: Vec<u8>

Signal

(client only)

Fields

signal: Sig

RequestSubsystem

(client only)

Fields

want_reply: bool

name: String

RequestX11

(client only)

Fields

want_reply: bool

single_connection: bool

x11_authentication_protocol: String

x11_authentication_cookie: String

x11_screen_number: u32

SetEnv

(client only)

Fields

want_reply: bool

variable_name: String

variable_value: String

WindowChange

(client only)

Fields

col_width: u32

row_height: u32

pix_width: u32

pix_height: u32

AgentForward

(client only)

Fields

want_reply: bool

XonXoff

(server only)

Fields

client_can_do: bool

ExitStatus

(server only)

Fields

exit_status: u32

ExitSignal

(server only)

Fields

signal_name: Sig

core_dumped: bool

error_message: String

lang_tag: String

WindowAdjusted

(server only)

Fields

new_size: u32

Success

(server only)

Failure

(server only)

OpenFailure(ChannelOpenFailure)

Trait Implementations

impl Debug for ChannelMsg

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

Formats the value using the given formatter.