Struct SessionVariables 

pub struct SessionVariables {

    pub hostname: String,
    pub username: String,
    pub path: String,
    pub job: Option<String>,
    pub last_command: Option<String>,
    pub profile_name: String,
    pub tty: String,
    pub columns: usize,
    pub rows: usize,
    pub bell_count: usize,
    pub selection: Option<String>,
    pub tmux_pane_title: Option<String>,
    pub exit_code: Option<i32>,
    pub current_command: Option<String>,
    pub custom: HashMap<String, String>,
}

Session variables available for badge interpolation

Fields

hostname: String

Remote hostname (from SSH or local)

username: String

Current username

path: String

Current working directory

job: Option<String>

Current foreground job name

last_command: Option<String>

Last executed command

profile_name: String

Current profile name

tty: String

TTY device name

columns: usize

Terminal columns

rows: usize

Terminal rows

bell_count: usize

Number of bells received

selection: Option<String>

Currently selected text

tmux_pane_title: Option<String>

tmux pane title (when in tmux mode)

exit_code: Option<i32>

Last command exit code (from shell integration)

current_command: Option<String>

Currently running command name (from shell integration)

custom: HashMap<String, String>

Custom variables set via escape sequences

Implementations

impl SessionVariables

pub fn new() -> Self

Create new session variables with system defaults

pub fn get(&self, name: &str) -> Option<String>

Get variable value by name

pub fn set_path(&mut self, path: String)

Update the working directory

pub fn set_dimensions(&mut self, cols: usize, rows: usize)

Update terminal dimensions

pub fn increment_bell(&mut self)

Increment bell count

pub fn set_custom(&mut self, name: &str, value: String)

Set a custom variable

pub fn set_exit_code(&mut self, code: Option<i32>)

Set the last command exit code

pub fn set_current_command(&mut self, command: Option<String>)

Set the currently running command name

Trait Implementations

impl Clone for SessionVariables

fn clone(&self) -> SessionVariables

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionVariables

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

Formats the value using the given formatter.

impl Default for SessionVariables

fn default() -> SessionVariables

Returns the “default value” for a type.