Struct tmux_interface::formats::formats_output::FormatsOutput

pub struct FormatsOutput<'a> {
    pub separator: char,
    pub variables: Vec<VariableOutput<'a>>,
}

Fields

separator: char

variables: Vec<VariableOutput<'a>>

Implementations

impl<'a> FormatsOutput<'a>

pub fn new() -> Self

pub fn separator(&mut self, c: char) -> &mut Self

set separator character

pub fn push(&mut self, variable: VariableOutput<'a>)

append with variable

pub fn from_string_ext(s: &str, format: &'a mut FormatsOutput<'a>)

pub fn alternate_on(&mut self, v: &'a mut Option<usize>) -> &mut Self

alternate_on - if pane is in alternate screen

pub fn alternate_saved_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

alternate_saved_x - Saved cursor X in alternate screen

pub fn alternate_saved_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

alternate_saved_y - Saved cursor Y in alternate screen

pub fn buffer_created(&mut self, v: &'a mut Option<u128>) -> &mut Self

buffer_created - Time buffer created

pub fn buffer_name(&mut self, v: &'a mut Option<String>) -> &mut Self

buffer_name - Name of buffer

pub fn buffer_sample(&mut self, v: &'a mut Option<String>) -> &mut Self

buffer_sample - First 50 characters from the specified buffer

pub fn buffer_size(&mut self, v: &'a mut Option<usize>) -> &mut Self

buffer_size - Size of the specified buffer in bytes

pub fn client_activity(&mut self, v: &'a mut Option<u128>) -> &mut Self

client_activity - Integer time client last had activity

pub fn client_cell_height(&mut self, v: &'a mut Option<usize>) -> &mut Self

client_cell_height - Height of each client cell in pixels

pub fn client_cell_width(&mut self, v: &'a mut Option<usize>) -> &mut Self

client_cell_width - Width of each client cell in pixels

pub fn client_created(&mut self, v: &'a mut Option<u128>) -> &mut Self

client_created - Integer time client created

pub fn client_control_mode(&mut self, v: &'a mut Option<bool>) -> &mut Self

client_control_mode - 1 if client is in control mode

pub fn client_discarded(&mut self, v: &'a mut Option<String>) -> &mut Self

client_discarded - Bytes discarded when client behind

pub fn client_height(&mut self, v: &'a mut Option<usize>) -> &mut Self

client_height - Height of client

pub fn client_key_table(&mut self, v: &'a mut Option<String>) -> &mut Self

client_key_table - Current key table

pub fn client_last_session(&mut self, v: &'a mut Option<String>) -> &mut Self

client_last_session - Name of the client’s last session

pub fn client_name(&mut self, v: &'a mut Option<String>) -> &mut Self

client_name - Name of client

pub fn client_pid(&mut self, v: &'a mut Option<bool>) -> &mut Self

client_pid - PID of client process

pub fn client_prefix(&mut self, v: &'a mut Option<bool>) -> &mut Self

client_prefix - 1 if prefix key has been pressed

pub fn client_readonly(&mut self, v: &'a mut Option<bool>) -> &mut Self

client_readonly - 1 if client is readonly

pub fn client_session(&mut self, v: &'a mut Option<String>) -> &mut Self

client_session - Name of the client’s session

pub fn client_termname(&mut self, v: &'a mut Option<String>) -> &mut Self

client_termname - Terminal name of client

pub fn client_tty(&mut self, v: &'a mut Option<String>) -> &mut Self

client_tty - Pseudo terminal of client

pub fn client_utf8(&mut self, v: &'a mut Option<bool>) -> &mut Self

client_utf8 - 1 if client supports UTF-8

pub fn client_width(&mut self, v: &'a mut Option<usize>) -> &mut Self

client_width - Width of client

pub fn client_written(&mut self, v: &'a mut Option<usize>) -> &mut Self

client_written - Bytes written to client

pub fn command_hooked(&mut self, v: &'a mut Option<String>) -> &mut Self

command_hooked - Name of command hooked, if any

pub fn command(&mut self, v: &'a mut Option<String>) -> &mut Self

command - Name of command in use, if any

pub fn command_list_name(&mut self, v: &'a mut Option<String>) -> &mut Self

command_list_name - Command name if listing commands

pub fn command_list_alias(&mut self, v: &'a mut Option<String>) -> &mut Self

command_list_alias - Command alias if listing commands

pub fn command_list_usage(&mut self, v: &'a mut Option<String>) -> &mut Self

command_list_usage - Command usage if listing commands

pub fn cursor_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

cursor_flag - Pane cursor flag

pub fn cursor_character(&mut self, v: &'a mut Option<String>) -> &mut Self

cursor_character - Character at cursor in pane

pub fn cursor_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

cursor_x - Cursor X position in pane

pub fn cursor_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

cursor_y - Cursor Y position in pane

pub fn copy_cursor_line(&mut self, v: &'a mut Option<String>) -> &mut Self

copy_cursor_line - Line the cursor is on in copy mode

pub fn copy_cursor_word(&mut self, v: &'a mut Option<String>) -> &mut Self

copy_cursor_word - Word under cursor in copy mode

pub fn copy_cursor_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

copy_cursor_x - Cursor X position in copy mode

pub fn copy_cursor_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

copy_cursor_y - Cursor Y position in copy mode

pub fn current_file(&mut self, v: &'a mut Option<String>) -> &mut Self

current_file - Current configuration file

pub fn histoty_bytes(&mut self, v: &'a mut Option<usize>) -> &mut Self

history_bytes Number of bytes in window history

pub fn history_limit(&mut self, v: &'a mut Option<usize>) -> &mut Self

history_limit Maximum window history lines

pub fn history_size(&mut self, v: &'a mut Option<usize>) -> &mut Self

history_size Size of history in bytes

pub fn hook(&mut self, v: &'a mut Option<String>) -> &mut Self

hook - Name of running hook, if any

pub fn hook_pane(&mut self, v: &'a mut Option<usize>) -> &mut Self

hook_pane - ID of pane where hook was run, if any

pub fn hook_session(&mut self, v: &'a mut Option<usize>) -> &mut Self

hook_session - ID of session where hook was run, if any

pub fn hook_session_name(&mut self, v: &'a mut Option<String>) -> &mut Self

hook_session_name - Name of session where hook was run, if any

pub fn hook_window(&mut self, v: &'a mut Option<usize>) -> &mut Self

hook_window - ID of window where hook was run, if any

pub fn hook_window_name(&mut self, v: &'a mut Option<String>) -> &mut Self

hook_window_name - Name of window where hook was run, if any

pub fn host(&mut self, v: &'a mut Option<String>) -> &mut Self

host - Hostname of local host

pub fn host_short(&mut self, v: &'a mut Option<String>) -> &mut Self

host_short - #h Hostname of local host (no domain name)

pub fn insert_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

insert_flag - Pane insert flag

pub fn keypad_cursor_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

keypad_cursor_flag - Pane keypad cursor flag

pub fn keypad_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

keypad_flag - Pane keypad flag

pub fn line(&mut self, v: &'a mut Option<usize>) -> &mut Self

line - Line number in the list

pub fn mouse_any_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_any_flag - Pane mouse any flag

pub fn mouse_button_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_button_flag - Pane mouse button flag

pub fn mouse_line(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_line - Line under mouse, if any

pub fn sgr_line(&mut self, v: &'a mut Option<String>) -> &mut Self

sgr_flag - Pane mouse SGR flag

pub fn mouse_standard_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_standard_flag - Pane mouse standard flag

pub fn mouse_all_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_all_flag - Pane mouse all flag

pub fn mouse_word(&mut self, v: &'a mut Option<String>) -> &mut Self

mouse_word - Word under mouse, if any

pub fn mouse_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

mouse_x - Mouse X position, if any

pub fn mouse_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

mouse_y - Mouse Y position, if any

pub fn origin_flag(&mut self, v: &'a mut Option<String>) -> &mut Self

origin_flag - Pane origin flag

pub fn pane_active(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_active - 1 if active pane

pub fn pane_at_bottom(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_at_bottom - 1 if pane is at the bottom of window

pub fn pane_at_left(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_at_left - 1 if pane is at the left of window

pub fn pane_at_right(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_at_right - 1 if pane is at the right of window

pub fn pane_at_top(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_at_top - 1 if pane is at the top of window

pub fn pane_bottom(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_bottom - Bottom of pane

pub fn pane_current_command(&mut self, v: &'a mut Option<String>) -> &mut Self

pane_current_command - Current command if available

pub fn pane_current_path(&mut self, v: &'a mut Option<String>) -> &mut Self

pane_current_path - Current path if available

pub fn pane_dead(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_dead - 1 if pane is dead

pub fn pane_dead_status(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_dead_status - Exit status of process in dead pane

pub fn pane_format(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_format - 1 if format is for a pane

pub fn pane_height(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_height - Height of pane

pub fn pane_id(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_id - #D Unique pane ID

pub fn pane_in_mode(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_in_mode - 1 if pane is in a mode

pub fn pane_index(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_index - #P Index of pane

pub fn pane_input_off(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_input_off - 1 if input to pane is disabled

pub fn pane_left(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_left - Left of pane

pub fn pane_marked(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_marked - 1 if this is the marked pane

pub fn pane_marked_set(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_marked_set - 1 if a marked pane is set

pub fn pane_mode(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_mode - Name of pane mode, if any

pub fn pane_path(&mut self, v: &'a mut Option<String>) -> &mut Self

pane_path - #T Path of pane (can be set by application)

pub fn pane_pid(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_pid - PID of first process in pane

pub fn pane_pipe(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_pipe - 1 if pane is being piped

pub fn pane_right(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_right - Right of pane

pub fn pane_search_string(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_search_string - Last search Option<String> in copy mode

pub fn pane_start_command(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_start_command - Command pane started with

pub fn pane_synchronized(&mut self, v: &'a mut Option<bool>) -> &mut Self

pane_synchronized - 1 if pane is synchronized

pub fn pane_tabs(&mut self, v: &'a mut Option<PaneTabs>) -> &mut Self

pane_tabs - Pane tab positions

pub fn pane_title(&mut self, v: &'a mut Option<String>) -> &mut Self

pane_title - #T Title of pane (can be set by application)

pub fn pane_top(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_top - Top of pane

pub fn pane_tty(&mut self, v: &'a mut Option<String>) -> &mut Self

pane_tty - Pseudo terminal of pane

pub fn pane_width(&mut self, v: &'a mut Option<usize>) -> &mut Self

pane_width - Width of pane

pub fn saved_cursor_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

saved_cursor_x - Saved cursor X in pane

pub fn saved_cursor_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

saved_cursor_y - Saved cursor Y in pane

pub fn pid(&mut self, v: &'a mut Option<usize>) -> &mut Self

pid - Server PID

pub fn rectangle_toggle(&mut self, v: &'a mut Option<bool>) -> &mut Self

rectangle_toggle - 1 if rectangle selection is activated

pub fn scroll_position(&mut self, v: &'a mut Option<usize>) -> &mut Self

scroll_position - Scroll position in copy mode

pub fn scroll_region_lower(&mut self, v: &'a mut Option<usize>) -> &mut Self

scroll_region_lower - Bottom of scroll region in pane

pub fn scroll_region_upper(&mut self, v: &'a mut Option<usize>) -> &mut Self

scroll_region_upper - Top of scroll region in pane

pub fn selection_active(&mut self, v: &'a mut Option<bool>) -> &mut Self

selection_active - 1 if selection started and changes with the curso

pub fn selection_end_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

selection_end_x - X position of the end of the selection

pub fn selection_end_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

selection_end_y - Y position of the end of the selection

pub fn selection_present(&mut self, v: &'a mut Option<bool>) -> &mut Self

selection_present - 1 if selection started in copy mode

pub fn selection_start_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

selection_start_x - X position of the start of the selection

pub fn selection_start_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

selection_start_y - Y position of the start of the selection

pub fn session_activity(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_activity - Time of session last activity

pub fn session_alerts(&mut self, v: &'a mut Option<String>) -> &mut Self

session_alerts - List of window indexes with alerts

pub fn session_attached(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_attached - Number of clients session is attached to

pub fn session_attached_list(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_attached_list - List of clients session is attached to

pub fn session_created(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_created - Time session created

pub fn session_format(&mut self, v: &'a mut Option<bool>) -> &mut Self

session_format - 1 if format is for a session (not assuming the current)

pub fn session_group(&mut self, v: &'a mut Option<String>) -> &mut Self

session_group - Name of session group

pub fn session_group_attached(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_group_attached - Number of clients sessions in group are attached >

pub fn session_group_attached_list( &mut self, v: &'a mut Option<String> ) -> &mut Self

session_group_attached_list - List of clients sessions in group are attached to

pub fn session_group_list(&mut self, v: &'a mut Option<String>) -> &mut Self

session_group_list - List of sessions in group

pub fn session_group_many_attached( &mut self, v: &'a mut Option<bool> ) -> &mut Self

session_group_many_attached - 1 if multiple clients attached to sessions in gro

pub fn session_group_size(&mut self, v: &'a mut Option<String>) -> &mut Self

session_group_size - Size of session group

pub fn session_grouped(&mut self, v: &'a mut Option<bool>) -> &mut Self

session_grouped - 1 if session in a group

pub fn session_id(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_id - Unique session ID

pub fn session_last_attached(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_last_attached - Time session last attached

pub fn session_many_attached(&mut self, v: &'a mut Option<bool>) -> &mut Self

session_many_attached - 1 if multiple clients attached

pub fn session_name(&mut self, v: &'a mut Option<String>) -> &mut Self

session_name - #S Name of session

pub fn session_stack(&mut self, v: &'a mut Option<SessionStack>) -> &mut Self

session_stack - Window indexes in most recent order

pub fn session_windows(&mut self, v: &'a mut Option<usize>) -> &mut Self

session_windows - Number of windows in session

pub fn socket_path(&mut self, v: &'a mut Option<String>) -> &mut Self

socket_path - Server socket path

pub fn start_time(&mut self, v: &'a mut Option<usize>) -> &mut Self

start_time - Server start time

pub fn version(&mut self, v: &'a mut Option<String>) -> &mut Self

version - Server version

pub fn window_active(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_active - 1 if window active

pub fn window_active_clients(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_active_clients - Number of clients viewing this window

pub fn window_active_clients_list( &mut self, v: &'a mut Option<String> ) -> &mut Self

window_active_clients_list - List of clients viewing this window

pub fn window_active_sessions(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_active_sessions - Number of sessions on which this window is active

pub fn window_active_sessions_list( &mut self, v: &'a mut Option<String> ) -> &mut Self

window_active_sessions_list - List of sessions on which this window is active

pub fn window_activity(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_activity - Time of window last activity

pub fn window_activity_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_activity_flag - 1 if window has activity

pub fn window_bell_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_bell_flag - 1 if window has bell

pub fn window_bigger(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_bigger - 1 if window is larger than client

pub fn window_cell_height(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_cell_height - Height of each cell in pixels

pub fn window_cell_width(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_cell_width - Width of each cell in pixels

pub fn window_end_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_end_flag - 1 if window has the highest index

pub fn window_flags(&mut self, v: &'a mut Option<WindowFlags>) -> &mut Self

window_flags - #F Window flags

pub fn window_raw_flags(&mut self, v: &'a mut Option<WindowFlags>) -> &mut Self

window_raw_flags - Window flags with nothing escaped

pub fn window_format(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_format - 1 if format is for a window

pub fn window_height(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_height - Height of window

pub fn window_id(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_id - Unique window ID

pub fn window_index(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_index - #I Index of window

pub fn window_last_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_last_flag - 1 if window is the last used

pub fn window_layout(&mut self, v: &'a mut Option<Layout>) -> &mut Self

window_layout - Window layout description, ignoring zoomed window panes

pub fn window_linked(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_linked - 1 if window is linked across sessions

pub fn window_linked_sessions(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_linked_sessions - Number of sessions this window is linked to

pub fn window_linked_sessions_list( &mut self, v: &'a mut Option<String> ) -> &mut Self

window_linked_sessions_list - List of sessions this window is linked to

pub fn window_marked_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_marked_flag - 1 if window contains the marked pane

pub fn window_name(&mut self, v: &'a mut Option<String>) -> &mut Self

window_name - #W Name of window

pub fn window_offset_x(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_offset_x - X offset into window if larger than client

pub fn window_offset_y(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_offset_y - Y offset into window if larger than client

pub fn window_panes(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_panes - Number of panes in window

pub fn window_silence_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_silence_flag - 1 if window has silence alert

pub fn window_stack_index(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_stack_index - Index in session most recent stack

pub fn window_start_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_start_flag - 1 if window has the lowest index

pub fn window_visible_layout(&mut self, v: &'a mut Option<Layout>) -> &mut Self

window_visible_layout - Window layout description, respecting zoomed window panes

pub fn window_width(&mut self, v: &'a mut Option<usize>) -> &mut Self

window_width - Width of window

pub fn window_zoomed_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

window_zoomed_flag - 1 if window is zoomed

pub fn wrap_flag(&mut self, v: &'a mut Option<bool>) -> &mut Self

wrap_flag - Pane wrap flag

Trait Implementations

impl<'a> Debug for FormatsOutput<'a>

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

Formats the value using the given formatter.

impl<'a> Default for FormatsOutput<'a>

fn default() -> Self

Returns the “default value” for a type.