Enum ChannelRequestContext

pub enum ChannelRequestContext<'b> {
    Pty {
        term: Bytes<'b>,
        width_chars: u32,
        height_chars: u32,
        width_pixels: u32,
        height_pixels: u32,
        modes: Bytes<'b>,
    },
    X11 {
        single_connection: Bool,
        x11_authentication_protocol: Bytes<'b>,
        x11_authentication_cookie: Bytes<'b>,
        x11_screen_number: u32,
    },
    Env {
        name: Bytes<'b>,
        value: Bytes<'b>,
    },
    Shell,
    Exec {
        command: Bytes<'b>,
    },
    Subsystem {
        name: Bytes<'b>,
    },
    WindowChange {
        width_chars: u32,
        height_chars: u32,
        width_pixels: u32,
        height_pixels: u32,
    },
    XonXoff {
        client_can_do: Bool,
    },
    Signal {
        name: Bytes<'b>,
    },
    ExitStatus {
        code: u32,
    },
    ExitSignal {
        name: Bytes<'b>,
        core_dumped: Bool,
        error_message: Utf8<'b>,
        language: Ascii<'b>,
    },
}

The context in the SSH_MSG_CHANNEL_REQUEST message.

Variants

Pty

A request of type pty-req, as defined in RFC4254 section 6.2.

Fields

term: Bytes<'b>

Peer’s $TERM environment variable value.

width_chars: u32

Terminal width, in columns.

height_chars: u32

Terminal height, in rows.

width_pixels: u32

Terminal width, in pixels.

height_pixels: u32

Terminal height, in pixels.

modes: Bytes<'b>

Encoded terminal modes.

X11

A request of type x11-req, as defined in RFC4254 section 6.3.

Fields

single_connection: Bool

Whether only a single connection should be forwarded.

x11_authentication_protocol: Bytes<'b>

X11 authentication protocol.

x11_authentication_cookie: Bytes<'b>

X11 authentication cookie.

x11_screen_number: u32

X11 authentication number.

Env

A request of type env, as defined in RFC4254 section 6.4.

Fields

name: Bytes<'b>

Environment variable name.

value: Bytes<'b>

Environment variable value.

Shell

A request of type shell, as defined in RFC4254 section 6.5.

Exec

A request of type exec, as defined in RFC4254 section 6.5.

Fields

command: Bytes<'b>

Command to be executed.

Subsystem

A request of type subsystem, as defined in RFC4254 section 6.5.

Fields

name: Bytes<'b>

Name of the requested subsystem.

WindowChange

A request of type window-change, as defined in RFC4254 section 6.7.

Fields

width_chars: u32

Terminal width, in columns.

height_chars: u32

Terminal height, in rows.

width_pixels: u32

Terminal width, in pixels.

height_pixels: u32

Terminal height, in pixels.

XonXoff

A request of type xon-xoff, as defined in RFC4254 section 6.8.

Fields

client_can_do: Bool

Whether the client is allowed to do flow control using <CTRL>-<S> and <CTRL>-<Q>.

Signal

A request of type signal, as defined in RFC4254 section 6.9.

Fields

name: Bytes<'b>

Signal name (without the “SIG” prefix).

ExitStatus

A request of type exit-status, as defined in RFC4254 section 6.10.

Fields

code: u32

Exit status, non-zero means failure.

ExitSignal

A request of type exit-signal, as defined in RFC4254 section 6.10.

Fields

name: Bytes<'b>

Signal name (without the “SIG” prefix).

core_dumped: Bool

Whether a core dump is triggering the signal.

error_message: Utf8<'b>

The error message for the signal.

language: Ascii<'b>

Language tag.

Implementations

impl ChannelRequestContext<'_>

pub fn as_ascii(&self) -> Ascii<'static>

Get the ChannelRequestContext’s SSH identifier.

Trait Implementations

impl<'b> BinRead for ChannelRequestContext<'b>

type Args<'__binrw_generated_args_lifetime> = (Ascii<'__binrw_generated_args_lifetime>,)

The type used for the args parameter of read_args() and read_options().

fn read_options<R: Read + Seek>( __binrw_generated_var_reader: &mut R, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<Self>

Read Self from the reader using the given Endian and arguments.

fn read<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments.

fn read_be<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming big-endian byte order.

fn read_le<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read Self from the reader using default arguments and assuming little-endian byte order.

fn read_ne<R>(reader: &mut R) -> Result<Self, Error>

where R: Read + Seek, Self::Args<'a>: for<'a> Required,

Read T from the reader assuming native-endian byte order.

fn read_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek, Self: ReadEndian,

Read Self from the reader using the given arguments.

fn read_be_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming big-endian byte order, using the given arguments.

fn read_le_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read Self from the reader, assuming little-endian byte order, using the given arguments.

fn read_ne_args<R>(reader: &mut R, args: Self::Args<'_>) -> Result<Self, Error>

where R: Read + Seek,

Read T from the reader, assuming native-endian byte order, using the given arguments.

impl<'b> BinWrite for ChannelRequestContext<'b>

type Args<'__binrw_generated_args_lifetime> = ()

The type used for the args parameter of write_args() and write_options().

fn write_options<W: Write + Seek>( &self, __binrw_generated_var_writer: &mut W, __binrw_generated_var_endian: Endian, __binrw_generated_var_arguments: Self::Args<'_>, ) -> BinResult<()>

Write Self to the writer using the given Endian and arguments.

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian, Self::Args<'a>: for<'a> Required,

Write Self to the writer using default arguments.

fn write_be<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming big-endian byte order.

fn write_le<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + Seek, Self::Args<'a>: for<'a> Required,

Write Self to the writer assuming little-endian byte order.

fn write_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek, Self: WriteEndian,

Write Self to the writer using the given arguments.

fn write_be_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming big-endian byte order, using the given arguments.

fn write_le_args<W>( &self, writer: &mut W, args: Self::Args<'_>, ) -> Result<(), Error>

where W: Write + Seek,

Write Self to the writer, assuming little-endian byte order, using the given arguments.

impl<'b> Clone for ChannelRequestContext<'b>

fn clone(&self) -> ChannelRequestContext<'b>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'b> Debug for ChannelRequestContext<'b>

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

Formats the value using the given formatter.

impl<'b> ReadEndian for ChannelRequestContext<'b>

const ENDIAN: EndianKind

The endianness of the type.

impl<'b> WriteEndian for ChannelRequestContext<'b>

const ENDIAN: EndianKind

The endianness of the type.