Struct SessionStore 

pub struct SessionStore { /* private fields */ }

In-memory storage for all sessions owned by the server.

Implementations

impl SessionStore

pub fn new() -> Self

Creates an empty session store.

pub fn len(&self) -> usize

Returns the number of sessions currently present.

pub fn is_empty(&self) -> bool

Returns whether the store contains no sessions.

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

Returns whether the addressed session exists.

pub fn session(&self, session_name: &SessionName) -> Option<&Session>

Returns an immutable reference to the named session.

pub fn session_by_id( &self, session_id: impl Into<SessionId>, ) -> Option<&Session>

Returns the session with the store-assigned $N identity.

pub fn iter(&self) -> impl Iterator<Item = (&SessionName, &Session)>

Returns an iterator over all sessions in the store.

pub fn session_group_name( &self, session_name: &SessionName, ) -> Option<&SessionName>

Returns the stable session group name for the addressed session.

pub fn runtime_owner(&self, session_name: &SessionName) -> Option<SessionName>

Returns the runtime-owning session for the addressed session.

pub fn runtime_owner_transfer_target( &self, session_name: &SessionName, ) -> Option<SessionName>

Returns the next runtime-owning session when the current runtime owner is removed.

pub fn session_group_members( &self, session_name: &SessionName, ) -> Vec<SessionName>

Returns the grouped peer sessions for the addressed session in stable name order.

pub fn session_group_size(&self, session_name: &SessionName) -> usize

Returns the number of sessions sharing the addressed session’s group.

pub fn contains_group(&self, group_name: &SessionName) -> bool

Returns whether a named session group exists.

pub fn sessions_in_group(&self, group_name: &SessionName) -> Vec<SessionName>

Returns grouped sessions for the named group in stable name order.

pub fn create_session( &mut self, session_name: SessionName, size: TerminalSize, ) -> Result<(), RmuxError>

Creates a session or returns DuplicateSession when the name exists.

pub fn create_session_with_base_index( &mut self, session_name: SessionName, size: TerminalSize, base_index: u32, ) -> Result<(), RmuxError>

Creates a session using the requested first window index.

pub fn create_auto_named_session_with_base_index( &mut self, size: TerminalSize, base_index: u32, ) -> Result<SessionName, RmuxError>

Creates an auto-named tmux-compatible session using the next global session id for both the $id and the visible session name.

pub fn create_grouped_session_with_base_index( &mut self, session_name: SessionName, size: TerminalSize, base_index: u32, group_target: SessionName, ) -> Result<GroupedSessionCreation, RmuxError>

Creates a session in an existing or newly-declared session group.

pub fn create_auto_grouped_session_with_base_index( &mut self, size: TerminalSize, base_index: u32, group_target: SessionName, ) -> Result<GroupedSessionCreation, RmuxError>

Creates an auto-named grouped session using tmux’s global session-id suffix rule (group-$id).

pub fn next_grouped_session_name(&self, group_name: &SessionName) -> SessionName

Returns the next available grouped-session name using tmux’s group-N prefix shape.

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

Removes a session or returns SessionNotFound when it is absent.

pub fn insert_existing_session( &mut self, session: Session, ) -> Result<(), RmuxError>

Inserts an existing session back into the store without rewriting it.

pub fn session_mut( &mut self, session_name: &SessionName, ) -> Option<&mut Session>

Returns a mutable reference to the named session.

pub const fn next_session_id(&self) -> SessionId

Returns the next session id that will be allocated.

pub const fn next_pane_id(&self) -> PaneId

Returns the next globally visible pane id that will be allocated.

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

Renames the addressed session by updating both the stored key and the session’s internal name.

pub fn allocate_pane_id(&mut self) -> PaneId

Allocates the next globally visible pane id for runtime-created panes.

impl SessionStore

pub fn resolve_session(&self, target: &Target) -> Result<&Session, RmuxError>

Resolves any exact target to its owning session.

pub fn resolve_session_mut( &mut self, target: &Target, ) -> Result<&mut Session, RmuxError>

Resolves any exact target to its owning mutable session.

pub fn resolve_window(&self, target: &Target) -> Result<&Window, RmuxError>

Resolves any exact target to the addressed session window.

pub fn resolve_window_mut( &mut self, target: &Target, ) -> Result<&mut Window, RmuxError>

Resolves any exact target to the addressed mutable session window.

pub fn resolve_pane(&self, target: &Target) -> Result<&Pane, RmuxError>

Resolves an exact pane target to an immutable pane reference.

pub fn resolve_pane_mut( &mut self, target: &Target, ) -> Result<&mut Pane, RmuxError>

Resolves an exact pane target to a mutable pane reference.

pub fn resolve_effective_pane( &self, target: &Target, ) -> Result<&Pane, RmuxError>

Resolves a target to the effective pane used by pane-oriented commands.

Session and window targets resolve to the session’s active pane. Pane targets resolve to the explicitly addressed pane.

pub fn resolve_effective_pane_mut( &mut self, target: &Target, ) -> Result<&mut Pane, RmuxError>

Resolves a target to the mutable effective pane used by pane-oriented commands.

Session and window targets resolve to the session’s active pane. Pane targets resolve to the explicitly addressed pane.

impl SessionStore

pub fn resolve_unresolved_target( &self, target: &UnresolvedTarget, find_type: TargetFindType, flags: TargetFindFlags, context: &TargetFindContext, ) -> Result<Target, RmuxError>

Resolves an unresolved command target to the existing typed target representation.

Trait Implementations

impl Debug for SessionStore

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

Formats the value using the given formatter.

impl Default for SessionStore

fn default() -> SessionStore

Returns the “default value” for a type.