Struct shpool_protocol::AttachHeader

pub struct AttachHeader {
    pub name: String,
    pub local_tty_size: TtySize,
    pub local_env: Vec<(String, String)>,
    pub ttl_secs: Option<u64>,
    pub cmd: Option<String>,
}

AttachHeader is the blob of metadata that a client transmits when it first dials into the shpool daemon indicating which shell it wants to attach to.

Fields

name: String

The name of the session to create or attach to.

local_tty_size: TtySize

The size of the local tty. Passed along so that the remote pty can be kept in sync (important so curses applications look right).

local_env: Vec<(String, String)>

A subset of the environment of the shell that shpool attach is run in. Contains only some variables needed to set up the shell when shpool forks off a process. For now the list is just SSH_AUTH_SOCK and TERM.

ttl_secs: Option<u64>

If specified, sets a time limit on how long the shell will be open when the shell is first created (does nothing in the case of a reattach). The daemon is responsible for automatically killing the session once the ttl is over.

cmd: Option<String>

If specified, a command to run instead of the users default shell.

Implementations

impl AttachHeader

pub fn local_env_get(&self, var: &str) -> Option<&str>

Trait Implementations

impl Debug for AttachHeader

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

Formats the value using the given formatter.

impl Default for AttachHeader

fn default() -> AttachHeader

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AttachHeader

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AttachHeader

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.