Struct ssh2::PtyModes

pub struct PtyModes { /* private fields */ }

Encodes modes for Pty allocation requests. The modes documented in https://tools.ietf.org/html/rfc4250#section-4.5 are supported.

Implementations

impl PtyModes

pub fn new() -> Self

Construct a PtyModes instance so that you can specify values for various modes

pub fn set_u32<O: Into<ExtensiblePtyModeOpcode>>(&mut self, option: O, value: u32)

Set a mode to an arbitrary u32 value

pub fn set_boolean<O: Into<ExtensiblePtyModeOpcode>>(
    &mut self,
    option: O,
    value: bool
)

Set a mode to a boolean value

pub fn set_character<O: Into<ExtensiblePtyModeOpcode>>(
    &mut self,
    option: O,
    c: Option<char>
)

Set a mode to a character value. If the character is None it is set to 255 to indicate that it is disabled. While this interface and the protocol accept unicode characters of up to 32 bits in width, these options likely only work for characters in the 7-bit ascii range.

pub fn finish(self) -> Vec<u8>

Finish accumulating modes and return the encoded byte stream suitable for use in the ssh2 protocol

Trait Implementations

impl Clone for PtyModes

fn clone(&self) -> PtyModes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PtyModes

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

Formats the value using the given formatter.