Struct SetupConnectionRequest

pub struct SetupConnectionRequest {
    pub target: String,
    pub user: String,
    pub env: HashMap<String, String>,
    pub command: String,
    pub argv: Vec<String>,
    pub window_rows: i32,
    pub window_cols: i32,
    pub nopty: bool,
    pub cwd: String,
    pub cwd_pid: i32,
}

Request to set up a connection to a container. This must be the first message sent to the server from the client.

Fields

target: String

Target container. “vm_shell” is a special value to get a VM shell.

user: String

User to execute the target program.

env: HashMap<String, String>

Map of environment variables to forward.

command: String

Deprecated. Target command. Empty indicates a login shell.

argv: Vec<String>

Argv of the target program to run. Empty indicates a login shell.

window_rows: i32

Initial window size (rows) of the pty.

window_cols: i32

Initial window size (cols) of the pty.

nopty: bool

True if using a noninteractive client and a pty should not be allocated. The logic here is inverted to keep backwards compatibility with the current behavior (always allocate a pty).

cwd: String

Optional: directory to set for current working directory.

cwd_pid: i32

Optional: use /proc/<cwd_pid>/cwd for current working directory.

Trait Implementations

impl Clone for SetupConnectionRequest

fn clone(&self) -> SetupConnectionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SetupConnectionRequest

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

Formats the value using the given formatter.

impl Default for SetupConnectionRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SetupConnectionRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SetupConnectionRequest

fn eq(&self, other: &SetupConnectionRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SetupConnectionRequest