tmux_interface::formats::formats

Struct Formats

Source 
pub struct Formats {
    pub separator: char,
    pub variables: Vec<Variable>,
}

Fields§

§separator: char§variables: Vec<Variable>

Implementations§

Source§

impl Formats

Source

pub fn new() -> Self

Source

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

set separator character

Source

pub fn push(&mut self, variable: Variable)

append with variable

Source

pub fn alternate_on(&mut self) -> &mut Self

alternate_on - if pane is in alternate screen

Source

pub fn alternate_saved_x(&mut self) -> &mut Self

alternate_saved_x - Saved cursor X in alternate screen

Source

pub fn alternate_saved_y(&mut self) -> &mut Self

alternate_saved_y - Saved cursor Y in alternate screen

Source

pub fn buffer_created(&mut self) -> &mut Self

buffer_created - Time buffer created

Source

pub fn buffer_name(&mut self) -> &mut Self

buffer_name - Name of buffer

Source

pub fn buffer_sample(&mut self) -> &mut Self

buffer_sample - First 50 characters from the specified buffer

Source

pub fn buffer_size(&mut self) -> &mut Self

buffer_size - Size of the specified buffer in bytes

Source

pub fn client_activity(&mut self) -> &mut Self

client_activity - Integer time client last had activity

Source

pub fn client_cell_height(&mut self) -> &mut Self

client_cell_height - Height of each client cell in pixels

Source

pub fn client_cell_width(&mut self) -> &mut Self

client_cell_width - Width of each client cell in pixels

Source

pub fn client_created(&mut self) -> &mut Self

client_created - Integer time client created

Source

pub fn client_control_mode(&mut self) -> &mut Self

client_control_mode - 1 if client is in control mode

Source

pub fn client_discarded(&mut self) -> &mut Self

client_discarded - Bytes discarded when client behind

Source

pub fn client_height(&mut self) -> &mut Self

client_height - Height of client

Source

pub fn client_key_table(&mut self) -> &mut Self

client_key_table - Current key table

Source

pub fn client_last_session(&mut self) -> &mut Self

client_last_session - Name of the client’s last session

Source

pub fn client_name(&mut self) -> &mut Self

client_name - Name of client

Source

pub fn client_pid(&mut self) -> &mut Self

client_pid - PID of client process

Source

pub fn client_prefix(&mut self) -> &mut Self

client_prefix - 1 if prefix key has been pressed

Source

pub fn client_readonly(&mut self) -> &mut Self

client_readonly - 1 if client is readonly

Source

pub fn client_session(&mut self) -> &mut Self

client_session - Name of the client’s session

Source

pub fn client_termname(&mut self) -> &mut Self

client_termname - Terminal name of client

Source

pub fn client_tty(&mut self) -> &mut Self

client_tty - Pseudo terminal of client

Source

pub fn client_utf8(&mut self) -> &mut Self

client_utf8 - 1 if client supports UTF-8

Source

pub fn client_width(&mut self) -> &mut Self

client_width - Width of client

Source

pub fn client_written(&mut self) -> &mut Self

client_written - Bytes written to client

Source

pub fn command_hooked(&mut self) -> &mut Self

command_hooked - Name of command hooked, if any

Source

pub fn command(&mut self) -> &mut Self

command - Name of command in use, if any

Source

pub fn command_list_name(&mut self) -> &mut Self

command_list_name - Command name if listing commands

Source

pub fn command_list_alias(&mut self) -> &mut Self

command_list_alias - Command alias if listing commands

Source

pub fn command_list_usage(&mut self) -> &mut Self

command_list_usage - Command usage if listing commands

Source

pub fn cursor_flag(&mut self) -> &mut Self

cursor_flag - Pane cursor flag

Source

pub fn cursor_character(&mut self) -> &mut Self

cursor_character - Character at cursor in pane

Source

pub fn cursor_x(&mut self) -> &mut Self

cursor_x - Cursor X position in pane

Source

pub fn cursor_y(&mut self) -> &mut Self

cursor_y - Cursor Y position in pane

Source

pub fn copy_cursor_line(&mut self) -> &mut Self

copy_cursor_line - Line the cursor is on in copy mode

Source

pub fn copy_cursor_word(&mut self) -> &mut Self

copy_cursor_word - Word under cursor in copy mode

Source

pub fn copy_cursor_x(&mut self) -> &mut Self

copy_cursor_x - Cursor X position in copy mode

Source

pub fn copy_cursor_y(&mut self) -> &mut Self

copy_cursor_y - Cursor Y position in copy mode

Source

pub fn current_file(&mut self) -> &mut Self

current_file - Current configuration file

Source

pub fn histoty_bytes(&mut self) -> &mut Self

history_bytes Number of bytes in window history

Source

pub fn history_limit(&mut self) -> &mut Self

history_limit Maximum window history lines

Source

pub fn history_size(&mut self) -> &mut Self

history_size Size of history in bytes

Source

pub fn hook(&mut self) -> &mut Self

hook - Name of running hook, if any

Source

pub fn hook_pane(&mut self) -> &mut Self

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

Source

pub fn hook_session(&mut self) -> &mut Self

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

Source

pub fn hook_session_name(&mut self) -> &mut Self

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

Source

pub fn hook_window(&mut self) -> &mut Self

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

Source

pub fn hook_window_name(&mut self) -> &mut Self

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

Source

pub fn host(&mut self) -> &mut Self

host - Hostname of local host

Source

pub fn host_short(&mut self) -> &mut Self

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

Source

pub fn insert_flag(&mut self) -> &mut Self

insert_flag - Pane insert flag

Source

pub fn keypad_cursor_flag(&mut self) -> &mut Self

keypad_cursor_flag - Pane keypad cursor flag

Source

pub fn keypad_flag(&mut self) -> &mut Self

keypad_flag - Pane keypad flag

Source

pub fn line(&mut self) -> &mut Self

line - Line number in the list

Source

pub fn mouse_any_flag(&mut self) -> &mut Self

mouse_any_flag - Pane mouse any flag

Source

pub fn mouse_button_flag(&mut self) -> &mut Self

mouse_button_flag - Pane mouse button flag

Source

pub fn mouse_line(&mut self) -> &mut Self

mouse_line - Line under mouse, if any

Source

pub fn sgr_line(&mut self) -> &mut Self

sgr_flag - Pane mouse SGR flag

Source

pub fn mouse_standard_flag(&mut self) -> &mut Self

mouse_standard_flag - Pane mouse standard flag

Source

pub fn mouse_status_line(&mut self) -> &mut Self

mouse_status_line - Status line on which mouse event took place

Source

pub fn mouse_status_range(&mut self) -> &mut Self

mouse_status_range - Range type or argument of mouse event on status line

Source

pub fn mouse_all_flag(&mut self) -> &mut Self

mouse_all_flag - Pane mouse all flag

Source

pub fn mouse_word(&mut self) -> &mut Self

mouse_word - Word under mouse, if any

Source

pub fn mouse_x(&mut self) -> &mut Self

mouse_x - Mouse X position, if any

Source

pub fn mouse_y(&mut self) -> &mut Self

mouse_y - Mouse Y position, if any

Source

pub fn origin_flag(&mut self) -> &mut Self

origin_flag - Pane origin flag

Source

pub fn pane_active(&mut self) -> &mut Self

pane_active - 1 if active pane

Source

pub fn pane_at_bottom(&mut self) -> &mut Self

pane_at_bottom - 1 if pane is at the bottom of window

Source

pub fn pane_at_left(&mut self) -> &mut Self

pane_at_left - 1 if pane is at the left of window

Source

pub fn pane_at_right(&mut self) -> &mut Self

pane_at_right - 1 if pane is at the right of window

Source

pub fn pane_at_top(&mut self) -> &mut Self

pane_at_top - 1 if pane is at the top of window

Source

pub fn pane_bottom(&mut self) -> &mut Self

pane_bottom - Bottom of pane

Source

pub fn pane_current_command(&mut self) -> &mut Self

pane_current_command - Current command if available

Source

pub fn pane_current_path(&mut self) -> &mut Self

pane_current_path - Current path if available

Source

pub fn pane_dead(&mut self) -> &mut Self

pane_dead - 1 if pane is dead

Source

pub fn pane_dead_status(&mut self) -> &mut Self

pane_dead_status - Exit status of process in dead pane

Source

pub fn pane_format(&mut self) -> &mut Self

pane_format - 1 if format is for a pane

Source

pub fn pane_height(&mut self) -> &mut Self

pane_height - Height of pane

Source

pub fn pane_id(&mut self) -> &mut Self

pane_id - #D Unique pane ID

Source

pub fn pane_in_mode(&mut self) -> &mut Self

pane_in_mode - 1 if pane is in a mode

Source

pub fn pane_index(&mut self) -> &mut Self

pane_index - #P Index of pane

Source

pub fn pane_input_off(&mut self) -> &mut Self

pane_input_off - 1 if input to pane is disabled

Source

pub fn pane_left(&mut self) -> &mut Self

pane_left - Left of pane

Source

pub fn pane_marked(&mut self) -> &mut Self

pane_marked - 1 if this is the marked pane

Source

pub fn pane_marked_set(&mut self) -> &mut Self

pane_marked_set - 1 if a marked pane is set

Source

pub fn pane_mode(&mut self) -> &mut Self

pane_mode - Name of pane mode, if any

Source

pub fn pane_path(&mut self) -> &mut Self

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

Source

pub fn pane_pid(&mut self) -> &mut Self

pane_pid - PID of first process in pane

Source

pub fn pane_pipe(&mut self) -> &mut Self

pane_pipe - 1 if pane is being piped

Source

pub fn pane_right(&mut self) -> &mut Self

pane_right - Right of pane

Source

pub fn pane_search_string(&mut self) -> &mut Self

pane_search_string - Last search Option<String> in copy mode

Source

pub fn pane_start_command(&mut self) -> &mut Self

pane_start_command - Command pane started with

Source

pub fn pane_synchronized(&mut self) -> &mut Self

pane_synchronized - 1 if pane is synchronized

Source

pub fn pane_tabs(&mut self) -> &mut Self

pane_tabs - Pane tab positions

Source

pub fn pane_title(&mut self) -> &mut Self

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

Source

pub fn pane_top(&mut self) -> &mut Self

pane_top - Top of pane

Source

pub fn pane_tty(&mut self) -> &mut Self

pane_tty - Pseudo terminal of pane

Source

pub fn pane_unseen_changes(&mut self) -> &mut Self

pane_unseen_changes - 1 if there were changes in pane while in mode

Source

pub fn pane_width(&mut self) -> &mut Self

pane_width - Width of pane

Source

pub fn saved_cursor_x(&mut self) -> &mut Self

saved_cursor_x - Saved cursor X in pane

Source

pub fn saved_cursor_y(&mut self) -> &mut Self

saved_cursor_y - Saved cursor Y in pane

Source

pub fn pid(&mut self) -> &mut Self

pid - Server PID

Source

pub fn rectangle_toggle(&mut self) -> &mut Self

rectangle_toggle - 1 if rectangle selection is activated

Source

pub fn scroll_position(&mut self) -> &mut Self

scroll_position - Scroll position in copy mode

Source

pub fn scroll_region_lower(&mut self) -> &mut Self

scroll_region_lower - Bottom of scroll region in pane

Source

pub fn scroll_region_upper(&mut self) -> &mut Self

scroll_region_upper - Top of scroll region in pane

Source

pub fn selection_active(&mut self) -> &mut Self

selection_active - 1 if selection started and changes with the curso

Source

pub fn selection_end_x(&mut self) -> &mut Self

selection_end_x - X position of the end of the selection

Source

pub fn selection_end_y(&mut self) -> &mut Self

selection_end_y - Y position of the end of the selection

Source

pub fn selection_present(&mut self) -> &mut Self

selection_present - 1 if selection started in copy mode

Source

pub fn selection_start_x(&mut self) -> &mut Self

selection_start_x - X position of the start of the selection

Source

pub fn selection_start_y(&mut self) -> &mut Self

selection_start_y - Y position of the start of the selection

Source

pub fn session_activity(&mut self) -> &mut Self

session_activity - Time of session last activity

Source

pub fn session_alerts(&mut self) -> &mut Self

session_alerts - List of window indexes with alerts

Source

pub fn session_attached(&mut self) -> &mut Self

session_attached - Number of clients session is attached to

Source

pub fn session_attached_list(&mut self) -> &mut Self

session_attached_list - List of clients session is attached to

Source

pub fn session_created(&mut self) -> &mut Self

session_created - Time session created

Source

pub fn session_format(&mut self) -> &mut Self

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

Source

pub fn session_group(&mut self) -> &mut Self

session_group - Name of session group

Source

pub fn session_group_attached(&mut self) -> &mut Self

session_group_attached - Number of clients sessions in group are attached >

Source

pub fn session_group_attached_list(&mut self) -> &mut Self

session_group_attached_list - List of clients sessions in group are attached to

Source

pub fn session_group_list(&mut self) -> &mut Self

session_group_list - List of sessions in group

Source

pub fn session_group_many_attached(&mut self) -> &mut Self

session_group_many_attached - 1 if multiple clients attached to sessions in gro

Source

pub fn session_group_size(&mut self) -> &mut Self

session_group_size - Size of session group

Source

pub fn session_grouped(&mut self) -> &mut Self

session_grouped - 1 if session in a group

Source

pub fn session_id(&mut self) -> &mut Self

session_id - Unique session ID

Source

pub fn session_last_attached(&mut self) -> &mut Self

session_last_attached - Time session last attached

Source

pub fn session_many_attached(&mut self) -> &mut Self

session_many_attached - 1 if multiple clients attached

Source

pub fn session_name(&mut self) -> &mut Self

session_name - #S Name of session

Source

pub fn session_stack(&mut self) -> &mut Self

session_stack - Window indexes in most recent order

Source

pub fn session_windows(&mut self) -> &mut Self

session_windows - Number of windows in session

Source

pub fn socket_path(&mut self) -> &mut Self

socket_path - Server socket path

Source

pub fn start_time(&mut self) -> &mut Self

start_time - Server start time

Source

pub fn version(&mut self) -> &mut Self

version - Server version

Source

pub fn window_active(&mut self) -> &mut Self

window_active - 1 if window active

Source

pub fn window_active_clients(&mut self) -> &mut Self

window_active_clients - Number of clients viewing this window

Source

pub fn window_active_clients_list(&mut self) -> &mut Self

window_active_clients_list - List of clients viewing this window

Source

pub fn window_active_sessions(&mut self) -> &mut Self

window_active_sessions - Number of sessions on which this window is active

Source

pub fn window_active_sessions_list(&mut self) -> &mut Self

window_active_sessions_list - List of sessions on which this window is active

Source

pub fn window_activity(&mut self) -> &mut Self

window_activity - Time of window last activity

Source

pub fn window_activity_flag(&mut self) -> &mut Self

window_activity_flag - 1 if window has activity

Source

pub fn window_bell_flag(&mut self) -> &mut Self

window_bell_flag - 1 if window has bell

Source

pub fn window_bigger(&mut self) -> &mut Self

window_bigger - 1 if window is larger than client

Source

pub fn window_cell_height(&mut self) -> &mut Self

window_cell_height - Height of each cell in pixels

Source

pub fn window_cell_width(&mut self) -> &mut Self

window_cell_width - Width of each cell in pixels

Source

pub fn window_end_flag(&mut self) -> &mut Self

window_end_flag - 1 if window has the highest index

Source

pub fn window_flags(&mut self) -> &mut Self

window_flags - #F Window flags

Source

pub fn window_raw_flags(&mut self) -> &mut Self

window_raw_flags - Window flags with nothing escaped

Source

pub fn window_format(&mut self) -> &mut Self

window_format - 1 if format is for a window

Source

pub fn window_height(&mut self) -> &mut Self

window_height - Height of window

Source

pub fn window_id(&mut self) -> &mut Self

window_id - Unique window ID

Source

pub fn window_index(&mut self) -> &mut Self

window_index - #I Index of window

Source

pub fn window_last_flag(&mut self) -> &mut Self

window_last_flag - 1 if window is the last used

Source

pub fn window_layout(&mut self) -> &mut Self

window_layout - Window layout description, ignoring zoomed window panes

Source

pub fn window_linked(&mut self) -> &mut Self

window_linked - 1 if window is linked across sessions

Source

pub fn window_linked_sessions(&mut self) -> &mut Self

window_linked_sessions - Number of sessions this window is linked to

Source

pub fn window_linked_sessions_list(&mut self) -> &mut Self

window_linked_sessions_list - List of sessions this window is linked to

Source

pub fn window_marked_flag(&mut self) -> &mut Self

window_marked_flag - 1 if window contains the marked pane

Source

pub fn window_name(&mut self) -> &mut Self

window_name - #W Name of window

Source

pub fn window_offset_x(&mut self) -> &mut Self

window_offset_x - X offset into window if larger than client

Source

pub fn window_offset_y(&mut self) -> &mut Self

window_offset_y - Y offset into window if larger than client

Source

pub fn window_panes(&mut self) -> &mut Self

window_panes - Number of panes in window

Source

pub fn window_silence_flag(&mut self) -> &mut Self

window_silence_flag - 1 if window has silence alert

Source

pub fn window_stack_index(&mut self) -> &mut Self

window_stack_index - Index in session most recent stack

Source

pub fn window_start_flag(&mut self) -> &mut Self

window_start_flag - 1 if window has the lowest index

Source

pub fn window_visible_layout(&mut self) -> &mut Self

window_visible_layout - Window layout description, respecting zoomed window panes

Source

pub fn window_width(&mut self) -> &mut Self

window_width - Width of window

Source

pub fn window_zoomed_flag(&mut self) -> &mut Self

window_zoomed_flag - 1 if window is zoomed

Source

pub fn wrap_flag(&mut self) -> &mut Self

wrap_flag - Pane wrap flag

Trait Implementations§

Source§

impl Debug for Formats

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Formats

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for Formats

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.