Struct HookStore 

pub struct HookStore { /* private fields */ }

In-memory storage for tmux-style hook arrays.

Implementations

impl HookStore

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

Dispatches against a pre-mutation snapshot and commits only the resulting one-shot consumption to this live store.

Reusing the same snapshot for an ordered event batch preserves normal fallback semantics and prevents a global one-shot from being copied to more than one deferred event.

impl HookStore

pub fn set_with_identity( &mut self, scope: HookScopeIdentity, hook: HookName, command: String, lifecycle: HookLifecycle, options: HookSetOptions, ) -> u32

Registers or mutates a hook at a stable, already-resolved scope.

pub fn unset_with_identity( &mut self, scope: &HookScopeIdentity, hook: HookName, index: Option<u32>, )

Removes a hook, or one indexed element, from a stable scope.

pub fn bindings_view_with_identity( &self, scope: &HookScopeIdentity, hook: Option<HookName>, ) -> Vec<HookBindingView>

Returns explicit bindings stored at a stable scope.

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

Resolves and consumes a hook using stable window and pane identities.

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

Dispatches through stable identity storage while retaining compatibility with callers that populated the legacy slot-keyed API directly.

pub fn dispatch_deferred_with_identity( &mut self, snapshot: &mut Self, scope: &HookScopeIdentity, hook: HookName, ) -> Vec<HookDispatch>

Dispatches from a pre-mutation snapshot and commits one-shot consumption to the live identity-keyed store.

pub fn dispatch_deferred_with_identity_or_scope( &mut self, snapshot: &mut Self, identity: &HookScopeIdentity, scope: &ScopeSelector, hook: HookName, ) -> Vec<HookDispatch>

Deferred counterpart of Self::dispatch_with_identity_or_scope.

pub fn retain_identities( &mut self, window_ids: &HashSet<WindowId>, pane_ids: &HashSet<PaneId>, )

Drops identity-keyed bindings whose owning objects no longer exist.

pub fn replace_identity_aliases( &mut self, window_aliases: HashMap<WindowTarget, WindowId>, pane_aliases: HashMap<PaneTarget, (WindowId, PaneId)>, )

Atomically replaces slot aliases used by the compatibility API and purges bindings for identities that are no longer live.

pub fn window_command_by_id( &self, window_id: WindowId, hook: HookName, ) -> Option<&str>

Returns the first exact identity-keyed window command.

pub fn pane_command_by_id( &self, pane_id: PaneId, hook: HookName, ) -> Option<&str>

Returns the first exact identity-keyed pane command.

impl HookStore

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.

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.

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for HookStore