Struct OptionStore 

pub struct OptionStore { /* private fields */ }

In-memory storage for supported RMUX option values.

Implementations

impl OptionStore

pub fn global_value(&self, option: OptionName) -> Option<&str>

Returns the exact explicit global value for the given known option.

pub fn session_value( &self, session_name: &SessionName, option: OptionName, ) -> Option<&str>

Returns the exact session-local value for the given known option.

pub fn window_value( &self, target: &WindowTarget, option: OptionName, ) -> Option<&str>

Returns the exact window-local value for the given known option.

pub fn pane_value( &self, target: &PaneTarget, option: OptionName, ) -> Option<&str>

Returns the exact pane-local value for the given known option.

pub fn resolve<'a>( &'a self, session_name: Option<&'a SessionName>, option: OptionName, ) -> Option<&'a str>

Resolves the effective value using the tmux-style parent chain for the known option.

pub fn resolve_for_window<'a>( &'a self, session_name: &'a SessionName, window_index: u32, option: OptionName, ) -> Option<&'a str>

Resolves the effective window value using the tmux-style parent chain.

pub fn resolve_for_pane<'a>( &'a self, session_name: &'a SessionName, window_index: u32, pane_index: u32, option: OptionName, ) -> Option<&'a str>

Resolves the effective pane value using the tmux-style parent chain.

pub fn resolve_array_values( &self, session_name: Option<&SessionName>, option: OptionName, ) -> Vec<String>

Resolves the effective array values for the known option.

pub fn resolve_name( &self, session_name: Option<&SessionName>, name: &str, ) -> Option<String>

Resolves a string-keyed option in a session context.

pub fn resolve_name_for_format( &self, session_name: Option<&SessionName>, name: &str, ) -> Option<String>

Resolves a string-keyed option for tmux format evaluation in a session context.

pub fn resolve_name_for_window( &self, session_name: &SessionName, window_index: u32, name: &str, ) -> Option<String>

Resolves a string-keyed option in a window context.

pub fn resolve_name_for_window_format( &self, session_name: &SessionName, window_index: u32, name: &str, ) -> Option<String>

Resolves a string-keyed option for tmux format evaluation in a window context.

pub fn resolve_name_for_pane( &self, session_name: &SessionName, window_index: u32, pane_index: u32, name: &str, ) -> Option<String>

Resolves a string-keyed option in a pane context.

pub fn resolve_name_for_pane_format( &self, session_name: &SessionName, window_index: u32, pane_index: u32, name: &str, ) -> Option<String>

Resolves a string-keyed option for tmux format evaluation in a pane context.

pub fn resolved( &self, session_name: &SessionName, ) -> HashMap<OptionName, String>

Returns the option snapshot that future panes in a session should inherit.

pub fn resolved_for_pane( &self, session_name: &SessionName, window_index: u32, pane_index: u32, ) -> HashMap<OptionName, String>

Returns the option snapshot for a pane after the full inheritance chain is applied.

impl OptionStore

pub fn show_options_lines( &self, scope: &OptionScopeSelector, value_only: bool, ) -> Result<Vec<String>, RmuxError>

Returns rendered show-options lines for the selected scope.

pub fn show_options_lines_filtered( &self, scope: &OptionScopeSelector, name: Option<&str>, value_only: bool, ) -> Result<Vec<String>, RmuxError>

Returns rendered show-options lines for the selected scope, optionally filtered by name.

pub fn show_options_lines_with_mode( &self, scope: &OptionScopeSelector, value_only: bool, mode: ShowOptionsMode, ) -> Result<Vec<String>, RmuxError>

Returns rendered show-options lines for the selected scope and mode.

pub fn show_options_lines_with_mode_filtered( &self, scope: &OptionScopeSelector, name: Option<&str>, value_only: bool, mode: ShowOptionsMode, ) -> Result<Vec<String>, RmuxError>

Returns rendered show-options lines for the selected scope, mode, and optional name.

impl OptionStore

pub fn new() -> Self

Creates an empty option store with no explicit overrides.

pub fn is_empty(&self) -> bool

Returns whether no explicit option overrides are present.

pub fn set( &mut self, scope: ScopeSelector, option: OptionName, value: String, mode: SetOptionMode, ) -> Result<OptionMutationOutcome, RmuxError>

Applies a mutation for a known legacy option.

pub fn set_by_name( &mut self, scope: OptionScopeSelector, name: &str, value: Option<String>, mode: SetOptionMode, only_if_unset: bool, unset: bool, unset_pane_overrides: bool, ) -> Result<OptionMutationOutcome, RmuxError>

Applies a mutation using a tmux-style string option name.

pub fn remove_session( &mut self, session_name: &SessionName, ) -> Option<HashMap<OptionName, String>>

Removes all option overrides owned by the given session.

pub fn rename_session( &mut self, session_name: &SessionName, new_name: SessionName, ) -> Result<(), RmuxError>

Rekeys all option overrides owned by the given session.

pub fn remove_window( &mut self, target: &WindowTarget, ) -> Option<HashMap<OptionName, String>>

Removes all window and pane option overrides owned by the given window.

pub fn remove_pane( &mut self, target: &PaneTarget, ) -> Option<HashMap<OptionName, String>>

Removes all pane option overrides owned by the given pane.

Trait Implementations

impl Clone for OptionStore

fn clone(&self) -> OptionStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OptionStore

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

Formats the value using the given formatter.

impl Default for OptionStore

fn default() -> OptionStore

Returns the “default value” for a type.

impl PartialEq for OptionStore

fn eq(&self, other: &OptionStore) -> 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 Eq for OptionStore

impl StructuralPartialEq for OptionStore