Struct EnvironmentStore 

pub struct EnvironmentStore { /* private fields */ }

In-memory storage for global and session-local environment values.

Implementations

impl EnvironmentStore

pub fn new() -> Self

Creates an empty environment store with no implicit defaults.

pub fn is_empty(&self) -> bool

Returns whether neither global nor session-local values are present.

pub fn set(&mut self, scope: ScopeSelector, name: String, value: String)

Stores the given visible value in the selected scope.

pub fn set_with_flags( &mut self, scope: ScopeSelector, name: String, value: String, flags: u8, )

Stores the given value and flag word in the selected scope.

pub fn clear(&mut self, scope: ScopeSelector, name: String)

Clears the selected variable, leaving a tombstone entry behind.

pub fn unset(&mut self, scope: ScopeSelector, name: &str) -> bool

Removes the selected variable entirely.

pub fn contains_entry(&self, scope: &ScopeSelector, name: &str) -> bool

Returns whether the exact entry exists in the selected scope.

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

Returns the exact global value for the given variable, when present and not cleared.

pub fn global_entries(&self) -> impl Iterator<Item = (&str, &str)>

Returns all exact global environment entries in unspecified order.

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

Returns the exact session-local value for the given variable, when present and not cleared.

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

Resolves a single variable using session-local then global lookup.

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

Returns the visible explicit environment snapshot that future panes should inherit.

pub fn apply_to_process_environment( &self, session_name: Option<&SessionName>, values: &mut HashMap<String, String>, )

Applies the selected scope chain to a process environment map.

pub fn update( &mut self, session_name: &SessionName, patterns: &[String], source: &HashMap<String, String>, )

Merges client variables into a session environment using tmux update-environment.

pub fn show_environment_entries( &self, scope: &ScopeSelector, hidden_only: bool, name: Option<&str>, ) -> Result<Vec<ShowEnvironmentEntry>, RmuxError>

Returns sorted show-environment entries for the selected global or session scope.

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

Removes all session-local values for the given session.

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

Rekeys all session-local values from one validated session name to another.

Trait Implementations

impl Clone for EnvironmentStore

fn clone(&self) -> EnvironmentStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentStore

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

Formats the value using the given formatter.

impl Default for EnvironmentStore

fn default() -> EnvironmentStore

Returns the “default value” for a type.

impl PartialEq for EnvironmentStore

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

impl StructuralPartialEq for EnvironmentStore