Struct HookStore 

pub struct HookStore { /* private fields */ }

In-memory storage for tmux-style hook arrays.

Implementations

impl HookStore

pub fn new() -> Self

Creates an empty hook store with no registered hooks.

pub fn is_empty(&self) -> bool

Returns whether no explicit hooks are present at any scope.

pub fn set( &mut self, scope: ScopeSelector, hook: HookName, command: String, lifecycle: HookLifecycle, ) -> Result<u32, RmuxError>

Registers or replaces a hook using tmux’s default index-zero semantics.

pub fn set_with_options( &mut self, scope: ScopeSelector, hook: HookName, command: String, lifecycle: HookLifecycle, options: HookSetOptions, ) -> Result<u32, RmuxError>

Registers or mutates a hook using indexed tmux array semantics.

pub fn unset( &mut self, scope: ScopeSelector, hook: HookName, index: Option<u32>, ) -> Result<(), RmuxError>

Removes a hook or a single indexed hook element.

pub fn global_command(&self, hook: HookName) -> Option<&str>

Returns the first explicit global command for the given hook, when present.

pub fn global_command_at(&self, hook: HookName, index: u32) -> Option<&str>

Returns the exact global command at the given array index, when present.

pub fn global_lifecycle(&self, hook: HookName) -> Option<HookLifecycle>

Returns the first explicit global lifecycle for the given hook, when present.

pub fn global_lifecycle_at( &self, hook: HookName, index: u32, ) -> Option<HookLifecycle>

Returns the exact global lifecycle at the given array index, when present.

pub fn session_command( &self, session_name: &SessionName, hook: HookName, ) -> Option<&str>

Returns the first exact session-local command for the given hook, when present.

pub fn session_command_at( &self, session_name: &SessionName, hook: HookName, index: u32, ) -> Option<&str>

Returns the exact session-local command at the given array index, when present.

pub fn session_lifecycle( &self, session_name: &SessionName, hook: HookName, ) -> Option<HookLifecycle>

Returns the first exact session-local lifecycle for the given hook, when present.

pub fn session_lifecycle_at( &self, session_name: &SessionName, hook: HookName, index: u32, ) -> Option<HookLifecycle>

Returns the exact session-local lifecycle at the given array index, when present.

pub fn window_command( &self, target: &WindowTarget, hook: HookName, ) -> Option<&str>

Returns the first exact window-local command for the given hook, when present.

pub fn pane_command(&self, target: &PaneTarget, hook: HookName) -> Option<&str>

Returns the first exact pane-local command for the given hook, when present.

pub fn global_bindings_view( &self, root: HookGlobalRoot, hook: Option<HookName>, ) -> Vec<HookBindingView>

Returns the explicit hook bindings for the requested global root.

pub fn session_bindings_view( &self, session_name: &SessionName, hook: Option<HookName>, ) -> Vec<HookBindingView>

Returns the explicit session-local hook bindings.

pub fn window_bindings_view( &self, target: &WindowTarget, hook: Option<HookName>, ) -> Vec<HookBindingView>

Returns the explicit window-local hook bindings.

pub fn pane_bindings_view( &self, target: &PaneTarget, hook: Option<HookName>, ) -> Vec<HookBindingView>

Returns the explicit pane-local hook bindings.

pub fn shipped_global_hooks( root: HookGlobalRoot, hook: Option<HookName>, ) -> Vec<HookName>

Returns the tmux-compatible hook inventory visible at the requested global root.

pub fn dispatch( &mut self, scope: &ScopeSelector, hook: HookName, ) -> Vec<HookDispatch>

Resolves a hook for the provided event scope and returns the matching command batch.

pub fn remove_session(&mut self, session_name: &SessionName) -> bool

Removes all hooks owned by the given session.

pub fn remove_window(&mut self, target: &WindowTarget) -> bool

Removes all hooks owned by the given window and its panes.

pub fn swap_window_hooks( &mut self, source: &WindowTarget, target: &WindowTarget, )

Swaps window and pane hooks between two winlink slots.

pub fn move_window_hooks( &mut self, source: &WindowTarget, target: &WindowTarget, )

Moves window and pane hooks from one winlink slot to another.

pub fn remove_pane(&mut self, target: &PaneTarget) -> bool

Removes all hooks owned by the given pane.

pub fn remap_session_window_indices( &mut self, session_name: &SessionName, index_map: &BTreeMap<u32, u32>, ) -> Result<(), RmuxError>

Rekeys window and pane hooks after a session window reindex.

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

Rekeys all hooks owned by the given session.

Trait Implementations

impl Clone for HookStore

fn clone(&self) -> HookStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookStore

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

Formats the value using the given formatter.

impl Default for HookStore

fn default() -> HookStore

Returns the “default value” for a type.

impl Eq for HookStore

impl PartialEq for HookStore

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